IPXV_Inst::FormatMeasureValue Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IPXV_Inst::FormatMeasureValue Method}} | {{#customTitle:IPXV_Inst::FormatMeasureValue Method}} | ||
{{#parentPage:PXV:IPXV_Inst#Methods|FormatMeasureValue|method}} | {{#parentPage:PXV:IPXV_Inst#Methods|FormatMeasureValue|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | The method | + | Converts the number value to display-string for the specified unit. The method uses the current UI-localization. |
== Syntax == | == Syntax == | ||
| Line 12: | Line 11: | ||
[in] MeasureUnit nDestUnit, | [in] MeasureUnit nDestUnit, | ||
[in, defaultvalue(0)] LONG nFmtFlags, | [in, defaultvalue(0)] LONG nFmtFlags, | ||
| − | [out, retval] BSTR* | + | [out, retval] BSTR* sRes);</pre> |
== Parameters == | == Parameters == | ||
;nValueInPoints | ;nValueInPoints | ||
| − | :[in] | + | :[in] The value in in points(1/72 in). |
;nDestUnit | ;nDestUnit | ||
| − | :[in] | + | :[in] The value of [[PXV:MeasureUnit|MeasureUnit]]. |
;nFmtFlags | ;nFmtFlags | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] An additional format flag, see [[PXV:PXV_FormatMeasureFlags|PXV_FormatMeasureFlags]]. |
| − | ; | + | ;sRes |
| − | :[out, retval] | + | :[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 for the specified unit. The method uses the current UI-localization.
Syntax
HRESULT FormatMeasureValue([in] double nValueInPoints,
[in] MeasureUnit nDestUnit,
[in, defaultvalue(0)] LONG nFmtFlags,
[out, retval] BSTR* sRes);
Parameters
- nValueInPoints
- [in] The value in in points(1/72 in).
- nDestUnit
- [in] The value of MeasureUnit.
- nFmtFlags
- [in, defaultvalue(0)] An additional format flag, see PXV_FormatMeasureFlags.
- sRes
- [out, retval] Returns string as result.
Return Value
Returns S_OK if operation was successful or error code in other cases.
