SignDoc SDK (C)  5.0.0
SIGNDOC_RenderOutput Class Reference

Output of SIGNDOC_Document_renderPageAsImage() and SIGNDOC_Document_renderPageAsSignDocImage(). More...

#include <SignDocSDK-c.h>

Public Member Functions

struct SIGNDOC_RenderOutputSIGNDOC_RenderOutput_new (struct SIGNDOC_Exception **aEx)
 SIGNDOC_RenderOutput constructor. More...
 
void SIGNDOC_RenderOutput_delete (struct SIGNDOC_RenderOutput *aObj)
 SIGNDOC_RenderOutput destructor. More...
 
int SIGNDOC_RenderOutput_getWidth (const struct SIGNDOC_RenderOutput *aObj)
 Get the width of the rendered page in pixels. More...
 
int SIGNDOC_RenderOutput_getHeight (const struct SIGNDOC_RenderOutput *aObj)
 Get the height of the rendered page in pixels. More...
 

Public Attributes

int mWidth
 The width of the rendered page in pixels. More...
 
int mHeight
 The height of the rendered page in pixels. More...
 

Detailed Description

Output of SIGNDOC_Document_renderPageAsImage() and SIGNDOC_Document_renderPageAsSignDocImage().

If multiple pages are selected (see "FirstPage" and "LastPage" of SIGNDOC_RenderParameters_setInteger()), the maximum width and maximum height of all selected pages will be used.

Member Function Documentation

void SIGNDOC_RenderOutput_delete ( struct SIGNDOC_RenderOutput aObj)

SIGNDOC_RenderOutput destructor.

Parameters
[in]aObjA pointer to the SIGNDOC_RenderOutput object.
int SIGNDOC_RenderOutput_getHeight ( const struct SIGNDOC_RenderOutput aObj)

Get the height of the rendered page in pixels.

Parameters
[in]aObjA pointer to the SIGNDOC_RenderOutput object.
Returns
The height of the rendered page in pixels.
int SIGNDOC_RenderOutput_getWidth ( const struct SIGNDOC_RenderOutput aObj)

Get the width of the rendered page in pixels.

Parameters
[in]aObjA pointer to the SIGNDOC_RenderOutput object.
Returns
The width of the rendered page in pixels.
struct SIGNDOC_RenderOutput * SIGNDOC_RenderOutput_new ( struct SIGNDOC_Exception **  aEx)

SIGNDOC_RenderOutput constructor.

Parameters
[out]aExAny exception will be returned in the object pointed to by this parameter.

Member Data Documentation

int mHeight

The height of the rendered page in pixels.

int mWidth

The width of the rendered page in pixels.


The documentation for this class was generated from the following file: