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 nNum, |
| − | [in, defaultvalue(2)] LONG | + | [in, defaultvalue(2)] LONG nDispPrec, |
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL bKeepZeroTrailers, |
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL bAllowGrouping, |
| − | [out, retval] BSTR* | + | [out, retval] BSTR* sRes);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;nNum |
:[in] The number value to be converted to string. | :[in] The number value to be converted to string. | ||
| − | ; | + | ;nDispPrec |
:[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. | ||
| − | ; | + | ;bKeepZeroTrailers |
:[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. | ||
| − | ; | + | ;bAllowGrouping |
:[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. | ||
| − | ; | + | ;sRes |
:[out, retval] Returns string as result. | :[out, retval] Returns string as result. | ||
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.
