IPXS_PDFVariant::Arr_GetBool Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 5: | Line 5: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Arr_GetBool([in] ULONG nIndex, [in, | + | <pre class="brush:cpp;gutter:false">HRESULT Arr_GetBool([in] ULONG nIndex, [in, defaultvalue(0)] VARIANT_BOOL nDefValue, [out, retval] VARIANT_BOOL* pVal);</pre> |
== Parameters == | == Parameters == | ||
| Line 11: | Line 11: | ||
:[in] Specifies an index of the element in the array. | :[in] Specifies an index of the element in the array. | ||
;''nDefValue'' | ;''nDefValue'' | ||
| − | :[in, | + | :[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value. |
;''pVal'' | ;''pVal'' | ||
:[out, retval] Pointer to VARIANT_BOOL variable that receives returned value. | :[out, retval] Pointer to VARIANT_BOOL variable that receives returned value. | ||
Revision as of 23:09, 16 April 2015
Returns a boolean value of specified element of array. If specified element has not PVT_BOOL type, nDefValue returned.
Contents
Syntax
HRESULT Arr_GetBool([in] ULONG nIndex, [in, defaultvalue(0)] VARIANT_BOOL nDefValue, [out, retval] VARIANT_BOOL* pVal);
Parameters
- nIndex
- [in] Specifies an index of the element in the array.
- nDefValue
- [in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value.
- pVal
- [out, retval] Pointer to VARIANT_BOOL variable that receives returned value.
Return Value
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when nDefValue returned.
See Also
See also IPXS_PDFVariant.
