ICabNode::GetBool Method
From PDF XChange PDF SDK
Line 22: | Line 22: | ||
;bVal | ;bVal | ||
:[out, retval] Pointer to VARIANT_BOOL. | :[out, retval] Pointer to VARIANT_BOOL. | ||
− | :The address of a | + | :The address of a variable that receives a referenced subnode 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. |
Latest revision as of 06:53, 15 June 2015
Returns the subnode value as a Boolean value (performing acceptable type conversion if necessary).
Syntax
HRESULT GetBool([in] LPWSTR sKey, [in, defaultvalue(0)] VARIANT_BOOL bDefVal, [out, retval] VARIANT_BOOL* bVal);
Parameters
- sKey
- [in] Value of LPWSTR.
- Identifies a subnode. See CAB subnode identification syntax.
- bDefVal
- [in, defaultvalue(0)] Value of VARIANT_BOOL.
- A value to be returned in case of error (subnode does not exist, has incompatible type etc.).
- bVal
- [out, retval] Pointer to VARIANT_BOOL.
- The address of a variable that receives a referenced subnode value.
Return Value
Returns S_OK if operation was successful or error code in other cases.