IPXV_Inst::FormatMeasureValue Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 6: Line 6:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Converts the number value to display-string for the specified unit.
  
 
== Syntax ==
 
== Syntax ==
Line 16: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;nValueInPoints
 
;nValueInPoints
:[in]  Value of double.
+
:[in]  The value in in points(1/72 in).
 
;nDestUnit
 
;nDestUnit
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
+
:[in]  The value of [[PXV:MeasureUnit|MeasureUnit]].
 
;nFmtFlags
 
;nFmtFlags
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  An additional format flag, see [[PXV:PXV_FormatMeasureFlags|PXV_FormatMeasureFlags]].
 
;ppRes
 
;ppRes
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Returns string as result.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 14:18, 28 May 2015


Converts the number value to display-string for the specified unit.

Syntax

HRESULT FormatMeasureValue([in]                   double       nValueInPoints,
                           [in]                   MeasureUnit  nDestUnit,
                           [in, defaultvalue(0)]  LONG         nFmtFlags,
                           [out, retval]          BSTR*        ppRes);

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.
ppRes
[out, retval] Returns string as result.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst