IPXC_DocumentInfo::SetInfoVar 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:IPXC_DocumentInfo::SetInfoVar Method}}
 
{{#customTitle:IPXC_DocumentInfo::SetInfoVar Method}}
 +
{{#parentPage:PXV:IPXC_DocumentInfo#Methods|SetInfoVar|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Sets value in the ''Info'' dictionary of the [[PXV:IPXS_Document|structure document]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT SetInfoVar([in] LPWSTR pKey, [in] IPXS_PDFVariant* pValue);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT SetInfoVar([in] LPWSTR           sKey,
 +
                  [in] IPXS_PDFVariant* pValue);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pKey''
+
;sKey
:[in]  Value of LPWSTR.
+
:[in]  Key that needs to be set with the given value.
;''pValue''
+
;pValue
:[in]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
:[in]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the value that needs to be set.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 20:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_DocumentInfo|IPXC_DocumentInfo]].
+
[[PXV:IPXC_DocumentInfo|IPXC_DocumentInfo]]

Latest revision as of 03:26, 15 June 2015

Sets value in the Info dictionary of the structure document.

Syntax

HRESULT SetInfoVar([in]  LPWSTR            sKey,
                   [in]  IPXS_PDFVariant*  pValue);

Parameters

sKey
[in] Key that needs to be set with the given value.
pValue
[in] Pointer to IPXS_PDFVariant containing the value that needs to be set.

Return Value

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

See Also

IPXC_DocumentInfo