IPXC_DocumentInfo::GetInfoVar Method

Latest revision as of 02:26, 15 June 2015

PDF Core Layer > Interfaces > IPXC_DocumentInfo > IPXC_DocumentInfo::GetInfoVar Method

Gets value from the Info dictionary of the structure document.

HRESULT GetInfoVar([in]           LPWSTR             sKey,
                   [out, retval]  IPXS_PDFVariant**  pValue);

sKey: [in] Key from which the value will be taken.
pValue: [out, retval] Pointer to IPXS_PDFVariant containing the value of the given key.

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IPXC_DocumentInfo::GetInfoVar Method}}
-{{#parentPage:PXV:IPXC_DocumentInfo|method}}
+{{#parentPage:PXV:IPXC_DocumentInfo#Methods|GetInfoVar|method}}
-{{ToWrite}}
-{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Gets value from the ''Info'' dictionary of the [[PXV:IPXS_Document|structure document]].
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT GetInfoVar([in] LPWSTR pKey, [out, retval] IPXS_PDFVariant** pValue);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT GetInfoVar([in]           LPWSTR             sKey,
+                   [out, retval]  IPXS_PDFVariant**  pValue);</pre>
 == Parameters ==
-;''pKey''
+;sKey
-:[in]  Value of LPWSTR.
+:[in]  Key from which the value will be taken.
-;''pValue''
+;pValue
-:[out, retval]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+:[out, retval]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the value of the given key.
 == Return Value ==
@@ Line 20: / Line 20: @@
 == See Also ==
-See also [[PXV:IPXC_DocumentInfo|IPXC_DocumentInfo]].
+[[PXV:IPXC_DocumentInfo|IPXC_DocumentInfo]]