IPXC_Article::GetInfo 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_Article::GetInfo Method}}
 
{{#customTitle:IPXC_Article::GetInfo Method}}
{{#parentPage:PXV:IPXC_Article|method}}
+
{{#parentPage:PXV:IPXC_Article#Methods|GetInfo|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
Gets info from the '''I''' dictionary of the article's [[PXV:IPXS_PDFVariant|PDF object]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetInfo([in] BSTR sKey, [out, retval] BSTR* pInfo);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetInfo([in]           BSTR   sKey,
 +
                [out, retval] BSTR* sInfo);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''sKey''
+
;sKey
:[in]  Value of BSTR.
+
:[in]  Key from '''I''' dictionary.
;''pInfo''
+
;sInfo
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Pointer to BSTR containing the entered key value.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Article|IPXC_Article]].
+
[[PXV:IPXC_Article|IPXC_Article]]

Latest revision as of 03:19, 15 June 2015

Gets info from the I dictionary of the article's PDF object.

Syntax

HRESULT GetInfo([in]           BSTR   sKey,
                [out, retval]  BSTR*  sInfo);

Parameters

sKey
[in] Key from I dictionary.
sInfo
[out, retval] Pointer to BSTR containing the entered key value.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IPXC_Article