IPXS_PDFVariant::Arr_GetString Method

From PDF XChange PDF SDK
Revision as of 03:42, 15 June 2015 by Dsbot (Talk | contribs) (Automatic page editing by robot)

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

The Returns the value of a specified element of an array as an unicode string (BSTR). If specified element type is not PVT_String sDefVal is returned.


HRESULT Arr_GetString([in]           ULONG  nIndex,
                      [in]           BSTR   sDefVal,
                      [out, retval]  BSTR*  sVal);


[in] Specifies the index of the array element.
[in] Default value that will be returned when specified index is out of range or the element type is not PVT_String.
[out, retval] Pointer to BSTR that receives the returned value.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also