IPXC_DocumentInfo::InfoStr Property

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_DocumentInfo::InfoStr Property}}
 
{{#customTitle:IPXC_DocumentInfo::InfoStr Property}}
{{#parentPage:PXV:IPXC_DocumentInfo|InfoStr Property|property}}
+
{{#parentPage:PXV:IPXC_DocumentInfo#Properties|InfoStr|property}}
{{ToWrite}}
+
{{ToReview}}
+
  
Property '''InfoStr''' of interface [[PXV:IPXC_DocumentInfo|IPXC_DocumentInfo]] returns/sets  Value of BSTR ...
+
Gets/sets info string by the [[PXV:PXC_DocumentInfoKey|document info key]].
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT get_InfoStr([in]          PXC_DocumentInfoKey  nKey,
 
<pre class="brush:cpp;gutter:false">HRESULT get_InfoStr([in]          PXC_DocumentInfoKey  nKey,
                     [out, retval]  BSTR*                ppString);
+
                     [out, retval]  BSTR*                sString);
 
HRESULT put_InfoStr([in]  PXC_DocumentInfoKey  nKey,
 
HRESULT put_InfoStr([in]  PXC_DocumentInfoKey  nKey,
                     [in]  BSTR                ppString);
+
                     [in]  BSTR                sString);
 
</pre>
 
</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;nKey
 
;nKey
:[in]  Value of [[PXV:PXC_DocumentInfoKey|PXC_DocumentInfoKey]].
+
:[in]  Value of [[PXV:PXC_DocumentInfoKey|PXC_DocumentInfoKey]] containing the type of info string that we need to get or set.
  
 
== 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

Gets/sets info string by the document info key.

Syntax

HRESULT get_InfoStr([in]           PXC_DocumentInfoKey  nKey,
                    [out, retval]  BSTR*                sString);
HRESULT put_InfoStr([in]  PXC_DocumentInfoKey  nKey,
                    [in]  BSTR                 sString);

Parameters

nKey
[in] Value of PXC_DocumentInfoKey containing the type of info string that we need to get or set.

See Also

IPXC_DocumentInfo