IPXS_PDFVariant::Arr_GetBool Method
From PDF XChange PDF SDK
| Line 2: | Line 2: | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetBool Method|method}} | {{#parentPage:PXV:IPXS_PDFVariant|Arr_GetBool Method|method}} | ||
| − | |||
Returns a boolean value of specified element of array. If specified element has not <code>PVT_Boolean</code> type, <code>nDefValue</code> returned. | Returns a boolean value of specified element of array. If specified element has not <code>PVT_Boolean</code> type, <code>nDefValue</code> returned. | ||
Revision as of 11:48, 14 May 2015
Returns a boolean value of specified element of array. If specified element has not PVT_Boolean 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.
