IPXV_Inst::FormatMeasureValue 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 FormatMeasureValue([in] double | + | <pre class="brush:cpp;gutter:false">HRESULT FormatMeasureValue([in] double nValueInPoints, |
− | [in] MeasureUnit | + | [in] MeasureUnit nDestUnit, |
− | [in, defaultvalue(0)] LONG | + | [in, defaultvalue(0)] LONG nFmtFlags, |
− | [out, retval] BSTR* | + | [out, retval] BSTR* sRes);</pre> |
== Parameters == | == Parameters == | ||
− | ; | + | ;nValueInPoints |
:[in] The value in in points(1/72 in). | :[in] The value in in points(1/72 in). | ||
− | ; | + | ;nDestUnit |
:[in] The value of [[PXV:MeasureUnit|MeasureUnit]]. | :[in] The value of [[PXV:MeasureUnit|MeasureUnit]]. | ||
− | ; | + | ;nFmtFlags |
:[in, defaultvalue(0)] An additional format flag, see [[PXV:PXV_FormatMeasureFlags|PXV_FormatMeasureFlags]]. | :[in, defaultvalue(0)] An additional format flag, see [[PXV:PXV_FormatMeasureFlags|PXV_FormatMeasureFlags]]. | ||
− | ; | + | ;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 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.