IPXC_Document::GetNameTreeA Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Document::GetNameTreeA Method}} | {{#customTitle:IPXC_Document::GetNameTreeA Method}} | ||
| − | {{#parentPage:PXV:IPXC_Document|GetNameTreeA | + | {{#parentPage:PXV:IPXC_Document#Methods|GetNameTreeA|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | The | + | Gets name tree from the document by the name dictionary key in atom representation. The keys should be used from Name dictionary table from the PDF standard specification. Use [[PXV:IPXS_Inst_StrToAtom|IPXS_Inst::StrToAtom]] method to get <code>ULONG</code> atom value. |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT GetNameTreeA([in] ULONG nTreeName, | <pre class="brush:cpp;gutter:false">HRESULT GetNameTreeA([in] ULONG nTreeName, | ||
| − | [out, retval] IPXC_NameTree** | + | [out, retval] IPXC_NameTree** pTree);</pre> |
== Parameters == | == Parameters == | ||
;nTreeName | ;nTreeName | ||
| − | :[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 22: | Line 21: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXC_Document|IPXC_Document]] | + | [[PXV:IPXC_Document|IPXC_Document]] |
Latest revision as of 03:25, 15 June 2015
Gets name tree from the document by the name dictionary key in atom representation. The keys should be used from Name dictionary table from the PDF standard specification. Use IPXS_Inst::StrToAtom method to get ULONG atom value.
Syntax
HRESULT GetNameTreeA([in] ULONG nTreeName,
[out, retval] IPXC_NameTree** pTree);
Parameters
- nTreeName
- [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.
