IPXC_StampsCollection::AddStamp Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_StampsCollection::AddStamp Method}}
 
{{#customTitle:IPXC_StampsCollection::AddStamp Method}}
 +
{{#parentPage:PXV:IPXC_StampsCollection#Methods|AddStamp|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT AddStamp([in] IAFS_File* pFile, [in] BSTR pID, [in, optional] ULONG nPage, [out, retval, optional] IPXC_StampInfo** ppStamp);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT AddStamp([in]                               IAFS_File*       pFile,
 +
                [in]                               BSTR             sID,
 +
                [in, defaultvalue(0)]             ULONG             nPage,
 +
                [out, retval, defaultvalue(NULL)] IPXC_StampInfo** pStamp);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pFile''
+
;pFile
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]].
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]].
;''pID''
+
;sID
 
:[in]  Value of BSTR.
 
:[in]  Value of BSTR.
;''nPage''
+
;nPage
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG.
;''ppStamp''
+
;pStamp
:[out, retval, optional]  Pointer to [[PXV:IPXC_StampInfo|IPXC_StampInfo]].
+
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_StampInfo|IPXC_StampInfo]].
  
 
== Return Value ==
 
== Return Value ==
Line 21: Line 28:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_StampsCollection|IPXC_StampsCollection]].
+
[[PXV:IPXC_StampsCollection|IPXC_StampsCollection]]

Latest revision as of 03:37, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT AddStamp([in]                               IAFS_File*        pFile,
                 [in]                               BSTR              sID,
                 [in, defaultvalue(0)]              ULONG             nPage,
                 [out, retval, defaultvalue(NULL)]  IPXC_StampInfo**  pStamp);

Parameters

pFile
[in] Pointer to IAFS_File.
sID
[in] Value of BSTR.
nPage
[in, defaultvalue(0)] Value of ULONG.
pStamp
[out, retval, defaultvalue(NULL)] Pointer to IPXC_StampInfo.

Return Value

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

See Also

IPXC_StampsCollection