IPXS_PDFVariant::Arr_GetString Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetString Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetString Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetString|method}} | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetString|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | The | + | The Returns the value of a specified element of an array as an unicode string ('''BSTR'''). If specified element type is not <code>PVT_String</code> <code>sDefVal</code> is returned. |
| + | |||
== Syntax == | == Syntax == | ||
| Line 15: | Line 15: | ||
== Parameters == | == Parameters == | ||
;nIndex | ;nIndex | ||
| − | :[in] | + | :[in] Specifies the index of the array element. |
;sDefVal | ;sDefVal | ||
| − | :[in] | + | :[in] Default value that will be returned when specified index is out of range or the element type is not <code>PVT_String</code>. |
;sVal | ;sVal | ||
| − | :[out, retval] | + | :[out, retval] Pointer to BSTR that receives the returned value. |
== Return Value == | == Return Value == | ||
Revision as of 23:44, 8 June 2015
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.
Syntax
HRESULT Arr_GetString([in] ULONG nIndex,
[in] BSTR sDefVal,
[out, retval] BSTR* sVal);
Parameters
- nIndex
- [in] Specifies the index of the array element.
- sDefVal
- [in] Default value that will be returned when specified index is out of range or the element type is not
PVT_String. - sVal
- [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.
