IPXC_Document::GetNameTree Method

Latest revision as of 03:25, 15 June 2015

PDF Core Layer > Interfaces > IPXC_Document > IPXC_Document::GetNameTree Method

Gets name tree from the document by the name dictionary key. The keys should be used from Name dictionary table from the PDF standard specification.

HRESULT GetNameTree([in]           LPWSTR           sTreeName,
                    [out, retval]  IPXC_NameTree**  pTree);

sTreeName: [in] Tree key value by which the tree would be extracted from the document.
pTree: [out, retval] Pointer to IPXC_NameTree containing the extracted name tree.

Returns S_OK if operation was successful or error code in other cases.

@@ Line 2: / Line 2: @@
 [[Category:Editor]]
 {{#customTitle:IPXC_Document::GetNameTree Method}}
-{{#parentPage:PXV:IPXC_Document|GetNameTree Method|method}}
+{{#parentPage:PXV:IPXC_Document#Methods|GetNameTree|method}}
-{{ToWrite}}
 {{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Gets name tree from the document by the name dictionary key. The keys should be used from Name dictionary table from the PDF standard specification.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT GetNameTree([in]           LPWSTR           pTreeName,
+<pre class="brush:cpp;gutter:false">HRESULT GetNameTree([in]           LPWSTR           sTreeName,
-                     [out, retval]  IPXC_NameTree**  ppTree);</pre>
+                     [out, retval]  IPXC_NameTree**  pTree);</pre>
 == Parameters ==
-;pTreeName
+;sTreeName
-:[in]  Value of LPWSTR.
+:[in]  Tree key value by which the tree would be extracted from the document.
-;ppTree
+;pTree
-:[out, retval]  Pointer to [[PXV:IPXC_NameTree|IPXC_NameTree]].
+:[out, retval]  Pointer to [[PXV:IPXC_NameTree|IPXC_NameTree]] containing the extracted name tree.
 == Return Value ==
@@ Line 22: / Line 21: @@
 == See Also ==
-[[PXV:IPXC_Document|IPXC_Document]].
+[[PXV:IPXC_Document|IPXC_Document]]