IPXV_Inst::FormatNumber Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| 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}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Converts the number value to display-string using the specified options. | |
== Syntax == | == Syntax == | ||
| Line 17: | Line 16: | ||
== Parameters == | == Parameters == | ||
;nNum | ;nNum | ||
| − | :[in] | + | :[in] The number value to be converted to string. |
;nDispPrec | ;nDispPrec | ||
| − | :[in, defaultvalue(2)] | + | :[in, defaultvalue(2)] The display precision, means the count of digits after decimal point. |
;bKeepZeroTrailers | ;bKeepZeroTrailers | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The flag to keep trailing zeros. By default all of them will be cropped. |
;bAllowGrouping | ;bAllowGrouping | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The flag to allow thousand-, billion- separator. It uses the regional user settings from the system. |
;ppRes | ;ppRes | ||
| − | :[out, retval] | + | :[out, retval] Returns string as result. |
== Return Value == | == Return Value == | ||
Revision as of 13:26, 28 May 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* ppRes);
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.
- ppRes
- [out, retval] Returns string as result.
Return Value
Returns S_OK if operation was successful or error code in other cases.
