IPXC_StampsCollection::AddStamp Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
Line 5: Line 5:
  
 
== 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 pID, [in, defaultvalue(0)] ULONG nPage, [out, retval, defaultvalue(NULL)] IPXC_StampInfo** ppStamp);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 13: Line 13:
 
:[in]  Value of BSTR.
 
:[in]  Value of BSTR.
 
;''nPage''
 
;''nPage''
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG.
 
;''ppStamp''
 
;''ppStamp''
:[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 ==

Revision as of 00:01, 17 April 2015

The method of interface of PDF-XChange Editor SDK.

Syntax

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

Parameters

pFile
[in] Pointer to IAFS_File.
pID
[in] Value of BSTR.
nPage
[in, defaultvalue(0)] Value of ULONG.
ppStamp
[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

See also IPXC_StampsCollection.