IIXC_Inst::Page_CreateEmpty Method

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(13 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#Methods|Page_CreateEmpty|method}}
  
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, [in] ULONG Height, [in] IXC_PageFormat Format, [in] ULONG defColor, [out, retval] IIXC_Page** ppPage);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Page_CreateEmpty([in]           ULONG           nWidth,
 +
                        [in]           ULONG           nHeight,
 +
                        [in]           IXC_PageFormat nFormat,
 +
                        [in]           ULONG           nDefColor,
 +
                        [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 23: Line 29:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Inst|IIXC_Inst]].
+
[[PXV:IIXC_Inst|IIXC_Inst]]

Latest revision as of 02:16, 15 June 2015

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