IPXS_PDFVariant::Arr_GetBool Method

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
Line 2: Line 2:
 
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Returns a boolean value of specified element of array. If specified element has not <code>PVT_BOOL</code> type, <code>nDefValue</code> returned.
  
 
== Syntax ==
 
== Syntax ==
Line 9: Line 9:
 
== Parameters ==
 
== Parameters ==
 
;''nIndex''
 
;''nIndex''
:[in] Value of ULONG.
+
:[in] Specifies an index of the element in the array.
 
;''nDefValue''
 
;''nDefValue''
:[in, optional] Value of VARIANT_BOOL.
+
:[in, optional] 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.
+
:[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_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>nDefValue</code> returned.
  
 
== See Also ==
 
== See Also ==
 
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
 
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].

Revision as of 10:18, 27 March 2015

Returns a boolean value of specified element of array. If specified element has not PVT_BOOL type, nDefValue returned.

Syntax

HRESULT Arr_GetBool([in] ULONG nIndex, [in, optional] VARIANT_BOOL nDefValue, [out, retval] VARIANT_BOOL* pVal);

Parameters

nIndex
[in] Specifies an index of the element in the array.
nDefValue
[in, optional] 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.