IPXC_NameTree::Item Method

Latest revision as of 03:30, 15 June 2015

Gets item by index with it's structure variant.

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

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

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