IPXC_Document::GetNameTree Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Document::GetNameTree Method}} | {{#customTitle:IPXC_Document::GetNameTree Method}} | ||
| + | {{#parentPage:PXV:IPXC_Document#Methods|GetNameTree|method}} | ||
| + | {{ToReview}} | ||
| − | The | + | 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 == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetNameTree([in] LPWSTR | + | <pre class="brush:cpp;gutter:false">HRESULT GetNameTree([in] LPWSTR sTreeName, |
| + | [out, retval] IPXC_NameTree** pTree);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;sTreeName |
| − | :[in] | + | :[in] Tree key value by which the tree would be extracted from the document. |
| − | ; | + | ;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 == | == Return Value == | ||
| Line 17: | Line 21: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_Document|IPXC_Document]] | |
Latest revision as of 02: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.
