ICabNode::GetDouble Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(2 intermediate revisions by one other user not shown)
Line 6: Line 6:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Returns the subnode value as a double precision floating point value (performing acceptable [[PXV:ICabNode:TypeConversions|type conversion]] if necessary).
  
 
== Syntax ==
 
== Syntax ==
Line 16: Line 16:
 
;sKey
 
;sKey
 
:[in]  Value of LPWSTR.
 
:[in]  Value of LPWSTR.
 +
:Identifies a subnode. See [[PXV:CAB:SubnodeIdentification|CAB subnode identification syntax]].
 
;nDefVal
 
;nDefVal
 
:[in, defaultvalue(0.0)]  Value of double.
 
:[in, defaultvalue(0.0)]  Value of double.
 +
:A value to be returned in case of error (subnode does not exist, has incompatible type etc.).
 
;nVal
 
;nVal
 
:[out, retval]  Pointer to double.
 
:[out, retval]  Pointer to double.
 
+
:The address of a <code>double</code> 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:00, 15 June 2015


Returns the subnode value as a double precision floating point value (performing acceptable type conversion if necessary).

Syntax

HRESULT GetDouble([in]                     LPWSTR   sKey,
                  [in, defaultvalue(0.0)]  double   nDefVal,
                  [out, retval]            double*  nVal);

Parameters

sKey
[in] Value of LPWSTR.
Identifies a subnode. See CAB subnode identification syntax.
nDefVal
[in, defaultvalue(0.0)] Value of double.
A value to be returned in case of error (subnode does not exist, has incompatible type etc.).
nVal
[out, retval] Pointer to double.
The address of a double variable that receives a referenced subnode value.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

ICabNode