IPXC_NameTree::Item Method

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 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_NameTree::Item Method}}
 
{{#customTitle:IPXC_NameTree::Item Method}}
{{#parentPage:PXV:IPXC_NameTree|method}}
+
{{#parentPage:PXV:IPXC_NameTree#Methods|Item|method}}
{{ToReview}}
+
  
 
Gets item by index with it's structure variant.
 
Gets item by index with it's structure variant.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Item([in] ULONG nIndex, [out] BSTR* ppName, [out] IPXS_PDFVariant** ppValue);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Item([in]   ULONG             nIndex,
 +
            [out] BSTR*             sName,
 +
            [out] IPXS_PDFVariant** pValue);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nIndex''
+
;nIndex
 
:[in]  Index of the item to get from the name tree.
 
:[in]  Index of the item to get from the name tree.
;''ppName''
+
;sName
 
:[out]  Resulting name of the item.
 
:[out]  Resulting name of the item.
;''ppValue''
+
;pValue
 
:[out]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the data of the item.
 
:[out]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the data of the item.
  
 
== 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_NameTree|IPXC_NameTree]].
+
[[PXV:IPXC_NameTree|IPXC_NameTree]]

Latest revision as of 03:30, 15 June 2015

Gets item by index with it's structure variant.

Syntax

HRESULT Item([in]   ULONG              nIndex,
             [out]  BSTR*              sName,
             [out]  IPXS_PDFVariant**  pValue);

Parameters

nIndex
[in] Index of the item to get from the name tree.
sName
[out] Resulting name of the item.
pValue
[out] Pointer to IPXS_PDFVariant containing the data of the item.

Return Value

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

See Also

IPXC_NameTree