IIXC_Inst::Page_CreateEmpty Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 7: Line 7:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Page_CreateEmpty([in]          ULONG          nWidth,
+
<pre class="brush:cpp;gutter:false">HRESULT Page_CreateEmpty([in]          ULONG          Width,
                         [in]          ULONG          nHeight,
+
                         [in]          ULONG          Height,
                         [in]          IXC_PageFormat  nFormat,
+
                         [in]          IXC_PageFormat  Format,
                         [in]          ULONG          nDefColor,
+
                         [in]          ULONG          defColor,
                         [out, retval]  IIXC_Page**    pPage);</pre>
+
                         [out, retval]  IIXC_Page**    Page);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nWidth
+
;Width
 
:[in]  Specifies the width of the new page.
 
:[in]  Specifies the width of the new page.
;nHeight
+
;Height
 
:[in]  Specifies the height of the new page.
 
:[in]  Specifies the height of the new page.
;nFormat
+
;Format
 
:[in]  Specifies internal [[PXV:IXC_PageFormat|format]] in which data will be stored into new page.
 
:[in]  Specifies internal [[PXV:IXC_PageFormat|format]] in which data will be stored into new page.
;nDefColor
+
;defColor
 
:[in]  Specifies color which will be used for filling entire page during creation.
 
:[in]  Specifies color which will be used for filling entire page during creation.
;pPage
+
;Page
 
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of created page will be stored.
 
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of created page will be stored.
  

Revision as of 06:50, 12 June 2015

The method creates new page with specified attributes (width, height, and format).

Syntax

HRESULT Page_CreateEmpty([in]           ULONG           Width,
                         [in]           ULONG           Height,
                         [in]           IXC_PageFormat  Format,
                         [in]           ULONG           defColor,
                         [out, retval]  IIXC_Page**     Page);

Parameters

Width
[in] Specifies the width of the new page.
Height
[in] Specifies the height of the new page.
Format
[in] Specifies internal format in which data will be stored into new page.
defColor
[in] Specifies color which will be used for filling entire page during creation.
Page
[out, retval] Pointer to IIXC_Page of created page will be stored.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IIXC_Inst