IPXS_PDFVariant::Dict_Get Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(4 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Dict_Get Method}}
 
{{#customTitle:IPXS_PDFVariant::Dict_Get Method}}
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Dict_Get Method|method}}
+
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Dict_Get|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Get dictionary value variant by Unicode name. To get better performance please use [[PXV:IPXS_PDFVariant_Dict_GetA|Dict_GetA]] function.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Dict_Get([in]          LPWSTR            key,
+
<pre class="brush:cpp;gutter:false">HRESULT Dict_Get([in]          LPWSTR            sKey,
                 [out, retval]  IPXS_PDFVariant**  ppItem);</pre>
+
                 [out, retval]  IPXS_PDFVariant**  pItem);</pre>
  
 
== Parameters ==
 
== Parameters ==
;key
+
;sKey
:[in]  Value of LPWSTR.
+
:[in]  Key name as Unicode string.
;ppItem
+
;pItem
:[out, retval]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
:[out, retval]  Pointer to the variable where the [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] pointer of the value variant will be stored.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if operation was successful.
 +
Returns S_FALSE if current variant is neither <code>PVT_Dictionary</code> nor <code>PVT_Stream</code>, or value with specified name not found in dictionary.
 +
Otherwise return error code.
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]], [[PXV:IPXS_PDFVariant_Dict_GetA|Dict_GetA]], [[PXV:IPXS_PDFVariant_Dict_GetR|Dict_GetR]]

Latest revision as of 09:05, 23 March 2016


Get dictionary value variant by Unicode name. To get better performance please use Dict_GetA function.

Syntax

HRESULT Dict_Get([in]           LPWSTR             sKey,
                 [out, retval]  IPXS_PDFVariant**  pItem);

Parameters

sKey
[in] Key name as Unicode string.
pItem
[out, retval] Pointer to the variable where the IPXS_PDFVariant pointer of the value variant will be stored.

Return Value

Returns S_OK if operation was successful. Returns S_FALSE if current variant is neither PVT_Dictionary nor PVT_Stream, or value with specified name not found in dictionary. Otherwise return error code.

See Also

IPXS_PDFVariant, Dict_GetA, Dict_GetR