Document properties

Functions
HPDF_STATUS	HPDF_SetInfoAttr (HPDF_Doc pdf, HPDF_InfoType type, const char *value)
	Set the text of info dictionary attribute using current encoding of the document. If encoding is not set, PDFDocEncoding is used. More...
const char *	HPDF_GetInfoAttr (HPDF_Doc pdf, HPDF_InfoType type)
	Get attribute value from info dictionary. More...
HPDF_STATUS	HPDF_SetInfoDateAttr (HPDF_Doc pdf, HPDF_InfoType type, HPDF_Date value)
	Set datetime attribute at info dictionary. More...

Detailed Description

Routines for document attributes processing

Function Documentation

HPDF_GetInfoAttr()

const char* HPDF_GetInfoAttr	(	HPDF_Doc	pdf,
		HPDF_InfoType	type
	)

Get attribute value from info dictionary.

Parameters

pdf	Document object handle.
type	One of the following values: HPDF_INFO_CREATION_DATE HPDF_INFO_MOD_DATE HPDF_INFO_AUTHOR HPDF_INFO_CREATOR HPDF_INFO_TITLE HPDF_INFO_SUBJECT HPDF_INFO_KEYWORDS

Returns

String value from info dictionary. If the infomation has not been set or an error has occurred, it returns NULL.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_INVALID_PARAMETER

See also

HPDF_SetInfoAttr(), HPDF_SetInfoDateAttr()

HPDF_SetInfoAttr()

HPDF_STATUS HPDF_SetInfoAttr	(	HPDF_Doc	pdf,
		HPDF_InfoType	type,
		const char *	value
	)

Set the text of info dictionary attribute using current encoding of the document. If encoding is not set, PDFDocEncoding is used.

Todo:

Clarify what PDFDocEncoding is.

Parameters

pdf	Document object handle.
type	One of the following values: HPDF_INFO_AUTHOR HPDF_INFO_CREATOR HPDF_INFO_TITLE HPDF_INFO_SUBJECT HPDF_INFO_KEYWORDS
value	Attribute text to be set.

Returns

HPDF_OK on success, otherwise returns error code and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_INVALID_PARAMETER

See also

HPDF_GetInfoAttr(), HPDF_SetInfoDateAttr()

HPDF_SetInfoDateAttr()

HPDF_STATUS HPDF_SetInfoDateAttr	(	HPDF_Doc	pdf,
		HPDF_InfoType	type,
		HPDF_Date	value
	)

Set datetime attribute at info dictionary.

Parameters

pdf	Document object handle.
type	One of the following attributes: HPDF_INFO_CREATION_DATE HPDF_INFO_MOD_DATE
value	New attribute value

Returns

HPDF_OK on success, otherwise returns error code and calls error handler.

Error codes

• HPDF_INVALID_DOCUMENT
• HPDF_FAILD_TO_ALLOC_MEM
• HPDF_INVALID_PARAMETER
• HPDF_INVALID_DATE_TIME

See also

HPDF_GetInfoAttr(), HPDF_SetInfoAttr(), _HPDF_Date