IPXC_Article::SetInfo Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Article::SetInfo Method}}
 
{{#customTitle:IPXC_Article::SetInfo Method}}
{{#parentPage:PXV:IPXC_Article|method}}
+
{{#parentPage:PXV:IPXC_Article#Methods|SetInfo|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
Sets info to the '''I''' dictionary of the article's [[PXV:IPXS_PDFVariant|PDF object]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT SetInfo([in] BSTR pKey, [in] BSTR pInfo);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT SetInfo([in] BSTR sKey,
 +
                [in] BSTR sInfo);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pKey''
+
;sKey
:[in]  Value of BSTR.
+
:[in]  Key from '''I''' dictionary which value will be set.
;''pInfo''
+
;sInfo
:[in]  Value of BSTR.
+
:[in]  Value of the key.
  
 
== 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:20, 15 June 2015

Sets info to the I dictionary of the article's PDF object.

Syntax

HRESULT SetInfo([in]  BSTR  sKey,
                [in]  BSTR  sInfo);

Parameters

sKey
[in] Key from I dictionary which value will be set.
sInfo
[in] Value of the key.

Return Value

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

See Also

IPXC_Article