CPageCustomData_interface.h File Reference

Interface for CPageCustomData wrapper. More...

Go to the source code of this file.

Functions
void	CPageCustomData_SetCustomData (CPageCustomData argCPageCustomData, const CMemoryBuffer argCustomData, idrs_exception *pargException)
	Set the custom data to be stored in this object. The iDRS will perform no interpretation of the provided buffer, and simply store it as-is.
CMemoryBuffer	CPageCustomData_GetCustomData (const CPageCustomData argCPageCustomData, idrs_exception *pargException)
	Get the custom data stored in this object.

Detailed Description

Interface for CPageCustomData wrapper.

Function Documentation

CPageCustomData_GetCustomData()

CMemoryBuffer CPageCustomData_GetCustomData	(	const CPageCustomData	argCPageCustomData,
		idrs_exception *	pargException
	)

Get the custom data stored in this object.

Returns

The custom data stored in this object

Remarks

The returned data is a copy of the data stored internally.

Parameters

argCPageCustomData	CPageCustomData handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageCustomData_SetCustomData()

void CPageCustomData_SetCustomData	(	CPageCustomData	argCPageCustomData,
		const CMemoryBuffer	argCustomData,
		idrs_exception *	pargException
	)

Set the custom data to be stored in this object. The iDRS will perform no interpretation of the provided buffer, and simply store it as-is.

Parameters

argCPageCustomData	CPageCustomData handle
argCustomData	The custom data
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

The provided data will be copied in an internal buffer.