IPXC_NameTree::Lookup Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_NameTree::Lookup Method}}
 
{{#customTitle:IPXC_NameTree::Lookup Method}}
 +
{{#parentPage:PXV:IPXC_NameTree#Methods|Lookup|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets structure variant by item name.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Lookup([in] BSTR pName, [out, retval] IPXS_PDFVariant** ppValue);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Lookup([in]           BSTR               sName,
 +
              [out, retval] IPXS_PDFVariant** pValue);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pName''
+
;sName
:[in]  Value of BSTR.
+
:[in]  Name of the item to look for in the name tree.
;''ppValue''
+
;pValue
:[out, retval]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
:[out, retval]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the resulting data of the item if found in the name tree.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_NameTree|IPXC_NameTree]].
+
[[PXV:IPXC_NameTree|IPXC_NameTree]]

Latest revision as of 03:30, 15 June 2015

Gets structure variant by item name.

Syntax

HRESULT Lookup([in]           BSTR               sName,
               [out, retval]  IPXS_PDFVariant**  pValue);

Parameters

sName
[in] Name of the item to look for in the name tree.
pValue
[out, retval] Pointer to IPXS_PDFVariant containing the resulting data of the item if found in the name tree.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IPXC_NameTree