IPXV_Inst::FormatNumber Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::FormatNumber Method}} | {{#customTitle:IPXV_Inst::FormatNumber Method}} | ||
+ | {{#parentPage:PXV:IPXV_Inst#Methods|FormatNumber|method}} | ||
+ | {{ToReview}} | ||
− | + | Converts the number value to display-string using the specified options. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT FormatNumber([in] double nNum, [in, | + | <pre class="brush:cpp;gutter:false">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);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;nNum |
− | :[in] | + | :[in] The number value to be converted to string. |
− | ; | + | ;nDispPrec |
− | :[in, | + | :[in, defaultvalue(2)] The display precision, means the count of digits after decimal point. |
− | ; | + | ;bKeepZeroTrailers |
− | :[in, | + | :[in, defaultvalue(0)] The flag to keep trailing zeros. By default all of them will be cropped. |
− | ; | + | ;bAllowGrouping |
− | :[in, | + | :[in, defaultvalue(0)] The flag to allow thousand-, billion- separator. It uses the regional user settings from the system. |
− | ; | + | ;sRes |
− | :[out, retval] | + | :[out, retval] Returns string as result. |
== Return Value == | == Return Value == | ||
Line 23: | Line 30: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IPXV_Inst|IPXV_Inst]] |
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.