CMetadataInfo_interface.h File Reference

Interface for CMetadataInfo wrapper. More...

Go to the source code of this file.

Functions
CMetadataInfo	CMetadataInfo_Create (idrs_exception *pargException)
	Create is instantiating a new instance of CMetadataInfo and associated data object.
void	CMetadataInfo_SetTitle (CMetadataInfo argCMetadataInfo, const idrs_string strTitle, idrs_exception *pargException)
	Sets the document title.
const idrs_string	CMetadataInfo_GetTitle (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the document title.
void	CMetadataInfo_SetAuthor (CMetadataInfo argCMetadataInfo, const idrs_string strAuthor, idrs_exception *pargException)
	Sets the author of the document.
const idrs_string	CMetadataInfo_GetAuthor (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the author of the document.
void	CMetadataInfo_SetSubject (CMetadataInfo argCMetadataInfo, const idrs_string strSubject, idrs_exception *pargException)
	Sets the subject of the document.
const idrs_string	CMetadataInfo_GetSubject (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the subject of the document.
void	CMetadataInfo_SetKeywords (CMetadataInfo argCMetadataInfo, const idrs_string strKeywords, idrs_exception *pargException)
	Sets the document keywords.
const idrs_string	CMetadataInfo_GetKeywords (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the document keywords.
void	CMetadataInfo_SetCreator (CMetadataInfo argCMetadataInfo, const idrs_string strCreator, idrs_exception *pargException)
	Sets the creator of the document.
const idrs_string	CMetadataInfo_GetCreator (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the creator of the document.
void	CMetadataInfo_SetProducer (CMetadataInfo argCMetadataInfo, const idrs_string strProducer, idrs_exception *pargException)
	Sets the producer of the document.
const idrs_string	CMetadataInfo_GetProducer (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the procudcer of the document.
void	CMetadataInfo_SetCompany (CMetadataInfo argCMetadataInfo, const idrs_string strCompany, idrs_exception *pargException)
	Sets the company name.
const idrs_string	CMetadataInfo_GetCompany (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the company name.
void	CMetadataInfo_SetManager (CMetadataInfo argCMetadataInfo, const idrs_string strManager, idrs_exception *pargException)
	Sets the manager name.
const idrs_string	CMetadataInfo_GetManager (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the manager name.
void	CMetadataInfo_SetCategory (CMetadataInfo argCMetadataInfo, const idrs_string strCategory, idrs_exception *pargException)
	Sets the category of the document.
const idrs_string	CMetadataInfo_GetCategory (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the category of the document.
void	CMetadataInfo_SetComment (CMetadataInfo argCMetadataInfo, const idrs_string strComment, idrs_exception *pargException)
	Sets the comments of the document.
const idrs_string	CMetadataInfo_GetComment (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the comments of the document.
void	CMetadataInfo_SetDescription (CMetadataInfo argCMetadataInfo, const idrs_string strDescription, idrs_exception *pargException)
	Sets the description of the document.
const idrs_string	CMetadataInfo_GetDescription (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the description of the document.
void	CMetadataInfo_SetCreationTime (CMetadataInfo argCMetadataInfo, const idrs_string strCreationTime, idrs_exception *pargException)
	Sets the creation time of the document.
const idrs_string	CMetadataInfo_GetCreationTime (const CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Gets the creation time of the document.
void	CMetadataInfo_Destroy (CMetadataInfo argCMetadataInfo, idrs_exception *pargException)
	Destroys a CMetadataInfo handle.

Detailed Description

Interface for CMetadataInfo wrapper.

Function Documentation

CMetadataInfo_Create()

CMetadataInfo CMetadataInfo_Create

(

idrs_exception *

pargException

)

Create is instantiating a new instance of CMetadataInfo and associated data object.

Returns

New instance of CMetadataInfo

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_Destroy()

void CMetadataInfo_Destroy	(	CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Destroys a CMetadataInfo handle.

Parameters

argCMetadataInfo	CMetadataInfo handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetAuthor()

const idrs_string CMetadataInfo_GetAuthor	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the author of the document.

Returns

The document author value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetCategory()

const idrs_string CMetadataInfo_GetCategory	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the category of the document.

Returns

The category value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetComment()

const idrs_string CMetadataInfo_GetComment	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the comments of the document.

Returns

The comments value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetCompany()

const idrs_string CMetadataInfo_GetCompany	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the company name.

Returns

The company name.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetCreationTime()

const idrs_string CMetadataInfo_GetCreationTime	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the creation time of the document.

Returns

The creation time value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetCreator()

const idrs_string CMetadataInfo_GetCreator	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the creator of the document.

Returns

The document creator value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetDescription()

const idrs_string CMetadataInfo_GetDescription	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the description of the document.

Returns

The description value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetKeywords()

const idrs_string CMetadataInfo_GetKeywords	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the document keywords.

Returns

The document keywords value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetManager()

const idrs_string CMetadataInfo_GetManager	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the manager name.

Returns

The manager name.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetProducer()

const idrs_string CMetadataInfo_GetProducer	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the procudcer of the document.

Returns

The document producer value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetSubject()

const idrs_string CMetadataInfo_GetSubject	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the subject of the document.

Returns

The document subject value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_GetTitle()

const idrs_string CMetadataInfo_GetTitle	(	const CMetadataInfo	argCMetadataInfo,
		idrs_exception *	pargException
	)

Gets the document title.

Returns

The document title value.

Parameters

argCMetadataInfo	CMetadataInfo handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetAuthor()

void CMetadataInfo_SetAuthor	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strAuthor,
		idrs_exception *	pargException
	)

Sets the author of the document.

Parameters

argCMetadataInfo	CMetadataInfo handle
strAuthor	The author value
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetCategory()

void CMetadataInfo_SetCategory	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strCategory,
		idrs_exception *	pargException
	)

Sets the category of the document.

Parameters

argCMetadataInfo	CMetadataInfo handle
strCategory	The category value
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetComment()

void CMetadataInfo_SetComment	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strComment,
		idrs_exception *	pargException
	)

Sets the comments of the document.

Parameters

argCMetadataInfo	CMetadataInfo handle
strComment	The comments value
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetCompany()

void CMetadataInfo_SetCompany	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strCompany,
		idrs_exception *	pargException
	)

Sets the company name.

Parameters

argCMetadataInfo	CMetadataInfo handle
strCompany	The company name
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetCreationTime()

void CMetadataInfo_SetCreationTime	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strCreationTime,
		idrs_exception *	pargException
	)

Sets the creation time of the document.

Parameters

argCMetadataInfo	CMetadataInfo handle
strCreationTime	The creation time
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

The creation time must be expressed in the ISO format YYYY-MM-DDThh:mm:ssTZD (e.g. 2017-09-23T19:20:30+02:00). However keyword "Z" will not be accepted as a valid time zone definition; use +00:00 instead. If the given format is invalid, an IDRS_ERROR_INVALID_ARGS exception will be thrown.

CMetadataInfo_SetCreator()

void CMetadataInfo_SetCreator	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strCreator,
		idrs_exception *	pargException
	)

Sets the creator of the document.

Parameters

argCMetadataInfo	CMetadataInfo handle
strCreator	The creator name value
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetDescription()

void CMetadataInfo_SetDescription	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strDescription,
		idrs_exception *	pargException
	)

Sets the description of the document.

Parameters

argCMetadataInfo	CMetadataInfo handle
strDescription	The comments value
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetKeywords()

void CMetadataInfo_SetKeywords	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strKeywords,
		idrs_exception *	pargException
	)

Sets the document keywords.

Parameters

argCMetadataInfo	CMetadataInfo handle
strKeywords	The keywords values
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetManager()

void CMetadataInfo_SetManager	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strManager,
		idrs_exception *	pargException
	)

Sets the manager name.

Parameters

argCMetadataInfo	CMetadataInfo handle
strManager	The manager name
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetProducer()

void CMetadataInfo_SetProducer	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strProducer,
		idrs_exception *	pargException
	)

Sets the producer of the document.

Parameters

argCMetadataInfo	CMetadataInfo handle
strProducer	The producer value
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetSubject()

void CMetadataInfo_SetSubject	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strSubject,
		idrs_exception *	pargException
	)

Sets the subject of the document.

Parameters

argCMetadataInfo	CMetadataInfo handle
strSubject	The subject value
pargException	Pointer to exception structure that will be filled if an exception occurs

CMetadataInfo_SetTitle()

void CMetadataInfo_SetTitle	(	CMetadataInfo	argCMetadataInfo,
		const idrs_string	strTitle,
		idrs_exception *	pargException
	)

Sets the document title.

Parameters

argCMetadataInfo	CMetadataInfo handle
strTitle	The title value
pargException	Pointer to exception structure that will be filled if an exception occurs