IPXC_Document::GetNameTree Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_Document::GetNameTree Method}} | {{#customTitle:IPXC_Document::GetNameTree Method}} | ||
{{#parentPage:PXV:IPXC_Document|GetNameTree Method|method}} | {{#parentPage:PXV:IPXC_Document|GetNameTree Method|method}} | ||
| − | |||
{{ToReview}} | {{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 == | ||
| Line 14: | Line 13: | ||
== Parameters == | == Parameters == | ||
;pTreeName | ;pTreeName | ||
| − | :[in] | + | :[in] Tree key value by which the tree would be extracted from the document. |
;ppTree | ;ppTree | ||
| − | :[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 == | ||
Revision as of 06:59, 21 May 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 pTreeName,
[out, retval] IPXC_NameTree** ppTree);
Parameters
- pTreeName
- [in] Tree key value by which the tree would be extracted from the document.
- ppTree
- [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.
