IPXS_PDFVariant::Arr_GetName Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 5: | Line 5: | ||
{{ToReview}} | {{ToReview}} | ||
| − | The Returns the value of a specified element of an array as an unicode string ('''BSTR'''). If specified element type is not <code>PVT_Name</code> <code> | + | The Returns the value of a specified element of an array as an unicode string ('''BSTR'''). If specified element type is not <code>PVT_Name</code> <code>sDefVal</code> is returned. |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Arr_GetName([in] ULONG | + | <pre class="brush:cpp;gutter:false">HRESULT Arr_GetName([in] ULONG nIndex, |
| − | [in] BSTR | + | [in] BSTR sDefVal, |
| − | [out, retval] BSTR* | + | [out, retval] BSTR* sVal);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;nIndex |
:[in] Specifies the index of the array element. | :[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 <code>PVT_Name</code>. | :[in] Default value that will be returned when specified index is out of range or the element type is not <code>PVT_Name</code>. | ||
| − | ; | + | ;sVal |
:[out, retval] Pointer to BSTR that receives the returned value. | :[out, retval] Pointer to BSTR that receives the returned value. | ||
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code> | + | Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>sDefVal</code> returned. |
== See Also == | == See Also == | ||
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | ||
Latest revision as of 03:42, 15 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_Name sDefVal is returned.
Syntax
HRESULT Arr_GetName([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_Name. - 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. Returns S_FALSE when sDefVal returned.
