IPXC_Document::GetNameTree Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetNameTree([in]          LPWSTR          sTreeName,
+
<pre class="brush:cpp;gutter:false">HRESULT GetNameTree([in]          LPWSTR          TreeName,
                     [out, retval]  IPXC_NameTree**  pTree);</pre>
+
                     [out, retval]  IPXC_NameTree**  Tree);</pre>
  
 
== Parameters ==
 
== Parameters ==
;sTreeName
+
;TreeName
 
:[in]  Tree key value by which the tree would be extracted from the document.
 
:[in]  Tree key value by which the tree would be extracted from the document.
;pTree
+
;Tree
 
:[out, retval]  Pointer to [[PXV:IPXC_NameTree|IPXC_NameTree]] containing the extracted name tree.
 
:[out, retval]  Pointer to [[PXV:IPXC_NameTree|IPXC_NameTree]] containing the extracted name tree.
  

Revision as of 07:00, 12 June 2015


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

HRESULT GetNameTree([in]           LPWSTR           TreeName,
                    [out, retval]  IPXC_NameTree**  Tree);

Parameters

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

Return Value

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

See Also

IPXC_Document