CPageZoneTable_interface.h File Reference

Interface for CPageZoneTable wrapper. More...

Go to the source code of this file.

Functions
CPageZoneTable	CPageZoneTable_Create (idrs_exception *pargException)
	Creates a new instance of CPageZoneTable.
CPageZoneTable	CPageZoneTable_Create2 (const CPageZone argPageZone, idrs_exception *pargException)
	Constructor using the base class.
IDRS_INT	CPageZoneTable_GetColsCount (const CPageZoneTable argCPageZoneTable, idrs_exception *pargException)
	Returns the number of columns in the table.
IDRS_INT	CPageZoneTable_GetRowsCount (const CPageZoneTable argCPageZoneTable, idrs_exception *pargException)
	Returns the number of rows in the table.
void	CPageZoneTable_SetColsCount (CPageZoneTable argCPageZoneTable, IDRS_INT const iColsCount, idrs_exception *pargException)
	Sets the number of columns in the table.
void	CPageZoneTable_SetRowsCount (CPageZoneTable argCPageZoneTable, IDRS_INT const iRowsCount, idrs_exception *pargException)
	Sets the number of rows in the table.
CPageTableCellArray	CPageZoneTable_GetCells (const CPageZoneTable argCPageZoneTable, idrs_exception *pargException)
	Retrieves the array of cells in the table.
void	CPageZoneTable_SetCells (CPageZoneTable argCPageZoneTable, const CPageTableCellArray argCells, idrs_exception *pargException)
	Sets an array containing the cells in the table.
void	CPageZoneTable_Destroy (CPageZoneTable argCPageZoneTable, idrs_exception *pargException)
	Destroys a CPageZoneTable handle.

Detailed Description

Interface for CPageZoneTable wrapper.

Function Documentation

CPageZoneTable_Create()

CPageZoneTable CPageZoneTable_Create

(

idrs_exception *

pargException

)

Creates a new instance of CPageZoneTable.

Parameters

pargException

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

Remarks

Instances created by this method can also be provided to CPageZone methods

Instances created by this method can also be provided to CPageCustomData methods

CPageZoneTable_Create2()

CPageZoneTable CPageZoneTable_Create2	(	const CPageZone	argPageZone,
		idrs_exception *	pargException
	)

Constructor using the base class.

Parameters

argPageZone	Base page zone
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to CPageZone methods

Instances created by this method can also be provided to CPageCustomData methods

CPageZoneTable_Destroy()

void CPageZoneTable_Destroy	(	CPageZoneTable	argCPageZoneTable,
		idrs_exception *	pargException
	)

Destroys a CPageZoneTable handle.

Parameters

argCPageZoneTable	CPageZoneTable handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZoneTable_GetCells()

CPageTableCellArray CPageZoneTable_GetCells	(	const CPageZoneTable	argCPageZoneTable,
		idrs_exception *	pargException
	)

Retrieves the array of cells in the table.

Parameters

argCPageZoneTable	CPageZoneTable handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZoneTable_GetColsCount()

IDRS_INT CPageZoneTable_GetColsCount	(	const CPageZoneTable	argCPageZoneTable,
		idrs_exception *	pargException
	)

Returns the number of columns in the table.

Parameters

argCPageZoneTable	CPageZoneTable handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZoneTable_GetRowsCount()

IDRS_INT CPageZoneTable_GetRowsCount	(	const CPageZoneTable	argCPageZoneTable,
		idrs_exception *	pargException
	)

Returns the number of rows in the table.

Parameters

argCPageZoneTable	CPageZoneTable handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZoneTable_SetCells()

void CPageZoneTable_SetCells	(	CPageZoneTable	argCPageZoneTable,
		const CPageTableCellArray	argCells,
		idrs_exception *	pargException
	)

Sets an array containing the cells in the table.

Parameters

argCPageZoneTable	CPageZoneTable handle
argCells	Array containing the cells in the table
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZoneTable_SetColsCount()

void CPageZoneTable_SetColsCount	(	CPageZoneTable	argCPageZoneTable,
		IDRS_INT const	iColsCount,
		idrs_exception *	pargException
	)

Sets the number of columns in the table.

Parameters

argCPageZoneTable	CPageZoneTable handle
iColsCount	Number of columns
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZoneTable_SetRowsCount()

void CPageZoneTable_SetRowsCount	(	CPageZoneTable	argCPageZoneTable,
		IDRS_INT const	iRowsCount,
		idrs_exception *	pargException
	)

Sets the number of rows in the table.

Parameters

argCPageZoneTable	CPageZoneTable handle
iRowsCount	Number of rows
pargException	Pointer to exception structure that will be filled if an exception occurs