IPXV_Inst::FormatNumber Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT FormatNumber([in] double | + | <pre class="brush:cpp;gutter:false">HRESULT FormatNumber([in] double Num, |
| − | [in, defaultvalue(2)] LONG | + | [in, defaultvalue(2)] LONG DispPrec, |
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL KeepZeroTrailers, |
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL AllowGrouping, |
| − | [out, retval] BSTR* | + | [out, retval] BSTR* Res);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;Num |
:[in] The number value to be converted to string. | :[in] The number value to be converted to string. | ||
| − | ; | + | ;DispPrec |
:[in, defaultvalue(2)] The display precision, means the count of digits after decimal point. | :[in, defaultvalue(2)] The display precision, means the count of digits after decimal point. | ||
| − | ; | + | ;KeepZeroTrailers |
:[in, defaultvalue(0)] The flag to keep trailing zeros. By default all of them will be cropped. | :[in, defaultvalue(0)] The flag to keep trailing zeros. By default all of them will be cropped. | ||
| − | ; | + | ;AllowGrouping |
:[in, defaultvalue(0)] The flag to allow thousand-, billion- separator. It uses the regional user settings from the system. | :[in, defaultvalue(0)] The flag to allow thousand-, billion- separator. It uses the regional user settings from the system. | ||
| − | ; | + | ;Res |
:[out, retval] Returns string as result. | :[out, retval] Returns string as result. | ||
Revision as of 06:32, 12 June 2015
Converts the number value to display-string using the specified options.
Syntax
HRESULT FormatNumber([in] double Num,
[in, defaultvalue(2)] LONG DispPrec,
[in, defaultvalue(0)] VARIANT_BOOL KeepZeroTrailers,
[in, defaultvalue(0)] VARIANT_BOOL AllowGrouping,
[out, retval] BSTR* Res);
Parameters
- Num
- [in] The number value to be converted to string.
- DispPrec
- [in, defaultvalue(2)] The display precision, means the count of digits after decimal point.
- KeepZeroTrailers
- [in, defaultvalue(0)] The flag to keep trailing zeros. By default all of them will be cropped.
- AllowGrouping
- [in, defaultvalue(0)] The flag to allow thousand-, billion- separator. It uses the regional user settings from the system.
- Res
- [out, retval] Returns string as result.
Return Value
Returns S_OK if operation was successful or error code in other cases.
