IPXV_Inst::FormatNumber Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
{{#customTitle:IPXV_Inst::FormatNumber Method}}
 
{{#customTitle:IPXV_Inst::FormatNumber Method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|FormatNumber|method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|FormatNumber|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Converts the number value to display-string using the specified options.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 12:
 
                     [in, defaultvalue(0)]  VARIANT_BOOL  bKeepZeroTrailers,
 
                     [in, defaultvalue(0)]  VARIANT_BOOL  bKeepZeroTrailers,
 
                     [in, defaultvalue(0)]  VARIANT_BOOL  bAllowGrouping,
 
                     [in, defaultvalue(0)]  VARIANT_BOOL  bAllowGrouping,
                     [out, retval]          BSTR*        ppRes);</pre>
+
                     [out, retval]          BSTR*        sRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;nNum
 
;nNum
:[in]  Value of double.
+
:[in]  The number value to be converted to string.
 
;nDispPrec
 
;nDispPrec
:[in, defaultvalue(2)]  Value of LONG.
+
:[in, defaultvalue(2)]  The display precision, means the count of digits after decimal point.
 
;bKeepZeroTrailers
 
;bKeepZeroTrailers
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  The flag to keep trailing zeros. By default all of them will be cropped.
 
;bAllowGrouping
 
;bAllowGrouping
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  The flag to allow thousand-, billion- separator. It uses the regional user settings from the system.  
;ppRes
+
;sRes
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Returns string as result.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 03:56, 15 June 2015


Converts the number value to display-string using the specified options.

Syntax

HRESULT FormatNumber([in]                   double        nNum,
                     [in, defaultvalue(2)]  LONG          nDispPrec,
                     [in, defaultvalue(0)]  VARIANT_BOOL  bKeepZeroTrailers,
                     [in, defaultvalue(0)]  VARIANT_BOOL  bAllowGrouping,
                     [out, retval]          BSTR*         sRes);

Parameters

nNum
[in] The number value to be converted to string.
nDispPrec
[in, defaultvalue(2)] The display precision, means the count of digits after decimal point.
bKeepZeroTrailers
[in, defaultvalue(0)] The flag to keep trailing zeros. By default all of them will be cropped.
bAllowGrouping
[in, defaultvalue(0)] The flag to allow thousand-, billion- separator. It uses the regional user settings from the system.
sRes
[out, retval] Returns string as result.

Return Value

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

See Also

IPXV_Inst