IPXS_PDFVariant::Arr_GetBool Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}} | ||
| Line 22: | Line 23: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]. | |
Revision as of 06:08, 20 May 2015
Returns a boolean value of specified element of array. If specified element has not PVT_Boolean type, nDefValue returned.
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.
