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)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Inst::Page_CreateEmpty Method}}
 
{{#customTitle:IIXC_Inst::Page_CreateEmpty Method}}
−
{{#parentPage:PXV:IIXC_Inst|Page_CreateEmpty Method|method}}
+
{{#parentPage:PXV:IIXC_Inst#Methods|Page_CreateEmpty|method}}
−
{{ToWrite}}
+
−
{{ToReview}}
+
  
−
The method of interface of PDF-XChange Editor SDK.
+
The method creates new [[PXV:IIXC_Page|page]] with specified attributes (width, height, and format).
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT Page_CreateEmpty([in]          ULONG          Width,
+
<pre class="brush:cpp;gutter:false">HRESULT Page_CreateEmpty([in]          ULONG          nWidth,
−
                         [in]          ULONG          Height,
+
                         [in]          ULONG          nHeight,
−
                         [in]          IXC_PageFormat  Format,
+
                         [in]          IXC_PageFormat  nFormat,
−
                         [in]          ULONG          defColor,
+
                         [in]          ULONG          nDefColor,
−
                         [out, retval]  IIXC_Page**    ppPage);</pre>
+
                         [out, retval]  IIXC_Page**    pPage);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;Width
+
;nWidth
−
:[in]  Value of ULONG.
+
:[in]  Specifies the width of the new page.
−
;Height
+
;nHeight
−
:[in]  Value of ULONG.
+
:[in]  Specifies the height of the new page.
−
;Format
+
;nFormat
−
:[in]  Value of [[PXV:IXC_PageFormat|IXC_PageFormat]].
+
:[in]  Specifies internal [[PXV:IXC_PageFormat|format]] in which data will be stored into new page.
−
;defColor
+
;nDefColor
−
:[in]  Value of ULONG.
+
:[in]  Specifies color which will be used for filling entire page during creation.
−
;ppPage
+
;pPage
−
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]].
+
:[out, retval]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of created page will be stored.
  
 
== Return Value ==
 
== Return Value ==
Line 30: Line 29:
  
 
== See Also ==
 
== See Also ==
−
See also [[PXV:IIXC_Inst|IIXC_Inst]].
+
[[PXV:IIXC_Inst|IIXC_Inst]]

Latest revision as of 03:16, 15 June 2015

Images Core Layer > Interfaces > IIXC_Inst > IIXC_Inst::Page_CreateEmpty Method

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

Syntax

HRESULT Page_CreateEmpty([in]           ULONG           nWidth,
                         [in]           ULONG           nHeight,
                         [in]           IXC_PageFormat  nFormat,
                         [in]           ULONG           nDefColor,
                         [out, retval]  IIXC_Page**     pPage);

Parameters

nWidth
[in] Specifies the width of the new page.
nHeight
[in] Specifies the height of the new page.
nFormat
[in] Specifies internal format in which data will be stored into new page.
nDefColor
[in] Specifies color which will be used for filling entire page during creation.
pPage
[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

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IIXC_Inst_Page_CreateEmpty&oldid=44522"