IPXV_Inst::Str2Number Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(4 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
{{#customTitle:IPXV_Inst::Str2Number Method}}
 
{{#customTitle:IPXV_Inst::Str2Number Method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|Str2Number|method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|Str2Number|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Converts the string into number.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Str2Number([in]                    BSTR          pStr,
+
<pre class="brush:cpp;gutter:false">HRESULT Str2Number([in]                    BSTR          sStr,
 
                   [in, defaultvalue(-1)]  VARIANT_BOOL  bSigned,
 
                   [in, defaultvalue(-1)]  VARIANT_BOOL  bSigned,
                   [out, defaultvalue(0)]  VARIANT_BOOL*  pOk,
+
                   [out, defaultvalue(0)]  VARIANT_BOOL*  bOK,
                   [out, retval]          double*        pRes);</pre>
+
                   [out, retval]          double*        nRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pStr
+
;sStr
:[in]  Value of BSTR.
+
:[in]  The string to be converted in number.
 
;bSigned
 
;bSigned
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  The flag to take into account the minus symbol from input string.
;pOk
+
;bOK
:[out, defaultvalue(0)]  Pointer to VARIANT_BOOL.
+
:[out, defaultvalue(0)]  Returns the <tt>true</tt> if converting was successful.
;pRes
+
;nRes
:[out, retval]  Pointer to double.
+
:[out, retval]  Returns the result of converting.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 03:58, 15 June 2015


Converts the string into number.

Syntax

HRESULT Str2Number([in]                    BSTR           sStr,
                   [in, defaultvalue(-1)]  VARIANT_BOOL   bSigned,
                   [out, defaultvalue(0)]  VARIANT_BOOL*  bOK,
                   [out, retval]           double*        nRes);

Parameters

sStr
[in] The string to be converted in number.
bSigned
[in, defaultvalue(-1)] The flag to take into account the minus symbol from input string.
bOK
[out, defaultvalue(0)] Returns the true if converting was successful.
nRes
[out, retval] Returns the result of converting.

Return Value

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

See Also

IPXV_Inst