IPXS_PDFVariant::Dict_Get Method

From PDF XChange PDF SDK
Revision as of 09:05, 23 March 2016 by Lzcat (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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


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


[in] Key name as Unicode string.
[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