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)
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Document::GetNameTree Method}}
 
{{#customTitle:IPXC_Document::GetNameTree Method}}
{{#parentPage:PXV:IPXC_Document#Methods|GetNameTree Method|method}}
+
{{#parentPage:PXV:IPXC_Document#Methods|GetNameTree|method}}
 
{{ToReview}}
 
{{ToReview}}
  
Line 8: Line 8:
  
 
== Syntax ==
 
== 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 ==
 
== Parameters ==
;pTreeName
+
;sTreeName
 
:[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.
;ppTree
+
;pTree
 
:[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.
  

Latest revision as of 03:25, 15 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           sTreeName,
                    [out, retval]  IPXC_NameTree**  pTree);

Parameters

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.

Return Value

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

See Also

IPXC_Document