IPXS_PDFVariant::Arr_GetBool Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}} | ||
| − | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetBool | + | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetBool|method}} |
| − | Returns a boolean value of specified element of array. If specified element has not <code>PVT_Boolean</code> type, <code> | + | Returns a boolean value of specified element of array. If specified element has not <code>PVT_Boolean</code> type, <code>bDefValue</code> returned. |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetBool([in] ULONG nIndex, | <pre class="brush:cpp;gutter:false">HRESULT Arr_GetBool([in] ULONG nIndex, | ||
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL bDefValue, |
| − | [out, retval] VARIANT_BOOL* | + | [out, retval] VARIANT_BOOL* bVal);</pre> |
== Parameters == | == Parameters == | ||
;nIndex | ;nIndex | ||
:[in] Specifies an index of the element in the array. | :[in] Specifies an index of the element in the array. | ||
| − | ; | + | ;bDefValue |
:[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value. | :[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value. | ||
| − | ; | + | ;bVal |
:[out, retval] Pointer to VARIANT_BOOL variable that receives returned value. | :[out, retval] Pointer to VARIANT_BOOL variable that receives 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>bDefValue</code> returned. |
== See Also == | == See Also == | ||
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | ||
Latest revision as of 02:41, 15 June 2015
Returns a boolean value of specified element of array. If specified element has not PVT_Boolean type, bDefValue returned.
Syntax
HRESULT Arr_GetBool([in] ULONG nIndex,
[in, defaultvalue(0)] VARIANT_BOOL bDefValue,
[out, retval] VARIANT_BOOL* bVal);
Parameters
- nIndex
- [in] Specifies an index of the element in the array.
- bDefValue
- [in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value.
- bVal
- [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 bDefValue returned.
