NPWInfo.c File Reference

Helper functions for document information. More...

#include "NPWInfo.h"

Go to the source code of this file.

Defines
#define	Chk(e)
	Check error returned by a function and returns it unless kNPWErrOk.
Functions
NPWErr	NPWInfoBegin (NPW *pdf)
	Begin information dictionary.
NPWErr	NPWInfoAddEntry (NPW *pdf, NPWConstText key, NPWConstText value)
	Add an information dictionary entry.
NPWErr	NPWInfoEnd (NPW *pdf)
	End information dictionary.

---

Detailed Description

Helper functions for document information.

Author:

Yves Piguet. Copyright 2008-2010, Yves Piguet.

Definition in file NPWInfo.c.

---

Define Documentation

#define Chk

(

e

)

Value:

do { \
        err = (e); \
        if (err != kNPWErrOk) \
            return err; \
    } while (0)

Check error returned by a function and returns it unless kNPWErrOk.

Definition at line 12 of file NPWInfo.c.

---

Function Documentation

NPWErr NPWInfoAddEntry	(	NPW *	pdf,
		NPWConstText	key,
		NPWConstText	value
	)

Add an information dictionary entry.

Parameters:

	pdf	reference to NPW structure
[in]	key	entry key (kNPWInfoKeyTitle etc.)
[in]	value	entry value (null-terminated string)

Returns:

error code (kNPWErrOk for success)

Definition at line 31 of file NPWInfo.c.

NPWErr NPWInfoBegin

(

NPW *

pdf

)

Begin information dictionary.

Parameters:

pdf

reference to NPW structure

Returns:

error code (kNPWErrOk for success)

Definition at line 20 of file NPWInfo.c.

NPWErr NPWInfoEnd

(

NPW *

pdf

)

End information dictionary.

Parameters:

pdf

reference to NPW structure

Returns:

error code (kNPWErrOk for success)

Definition at line 43 of file NPWInfo.c.