iDRS™ SDK 16
Loading...
Searching...
No Matches
CPageZoneGraphic_interface.h File Reference

Interface for CPageZoneGraphic wrapper. More...

Go to the source code of this file.

Functions

CPageZoneGraphic CPageZoneGraphic_Create (idrs_exception *pargException)
 Creates a new instance of CPageZoneGraphic.
 
CPageZoneGraphic CPageZoneGraphic_Create2 (const CPageZone argPageZone, idrs_exception *pargException)
 Constructor using the base class.
 
enum PageZoneGraphicSource CPageZoneGraphic_GetGraphicSourceType (const CPageZoneGraphic argCPageZoneGraphic, idrs_exception *pargException)
 Retrieves the source type for the graphical zone.
 
void CPageZoneGraphic_Destroy (CPageZoneGraphic argCPageZoneGraphic, idrs_exception *pargException)
 Destroys a CPageZoneGraphic handle.
 

Detailed Description

Interface for CPageZoneGraphic wrapper.

Function Documentation

◆ CPageZoneGraphic_Create()

CPageZoneGraphic CPageZoneGraphic_Create ( idrs_exception *  pargException)

Creates a new instance of CPageZoneGraphic.

Parameters
pargExceptionPointer 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

◆ CPageZoneGraphic_Create2()

CPageZoneGraphic CPageZoneGraphic_Create2 ( const CPageZone  argPageZone,
idrs_exception *  pargException 
)

Constructor using the base class.

Parameters
argPageZoneBase page zone
pargExceptionPointer 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

◆ CPageZoneGraphic_Destroy()

void CPageZoneGraphic_Destroy ( CPageZoneGraphic  argCPageZoneGraphic,
idrs_exception *  pargException 
)

Destroys a CPageZoneGraphic handle.

Parameters
argCPageZoneGraphicCPageZoneGraphic handle to destroy
pargExceptionPointer to exception structure that will be filled if an exception occurs

◆ CPageZoneGraphic_GetGraphicSourceType()

enum PageZoneGraphicSource CPageZoneGraphic_GetGraphicSourceType ( const CPageZoneGraphic  argCPageZoneGraphic,
idrs_exception *  pargException 
)

Retrieves the source type for the graphical zone.

The type can only be set by constructing the desired object type: CPageGraphic or CPageZoneGraphicExternalImage

Parameters
argCPageZoneGraphicCPageZoneGraphic handle
pargExceptionPointer to exception structure that will be filled if an exception occurs