IPXV_Inst::GetMeasureUnitInfo 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.
+
Gets information about specified unit of measurement.
  
 
== Syntax ==
 
== Syntax ==
Line 19: Line 19:
 
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
 
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
 
;ppName
 
;ppName
:[out]  Pointer to BSTR.
+
:[out]  Returns display-name of unit.
 
;ppShortName
 
;ppShortName
:[out]  Pointer to BSTR.
+
:[out]  Returns short display-name of unit.
 
;pPt2UnitCoef
 
;pPt2UnitCoef
:[out]  Pointer to double.
+
:[out]  Returns translation coefficient from points(1/72 in) to the unit.
 
;pDispPrec
 
;pDispPrec
:[out]  Pointer to LONG.
+
:[out]  Returns precision(number of digits after decimal point) for displaying values of the unit.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 18:26, 24 May 2015


Gets information about specified unit of measurement.

Syntax

HRESULT GetMeasureUnitInfo([in]   MeasureUnit  nUnit,
                           [out]  BSTR*        ppName,
                           [out]  BSTR*        ppShortName,
                           [out]  double*      pPt2UnitCoef,
                           [out]  LONG*        pDispPrec);

Parameters

nUnit
[in] Value of MeasureUnit.
ppName
[out] Returns display-name of unit.
ppShortName
[out] Returns short display-name of unit.
pPt2UnitCoef
[out] Returns translation coefficient from points(1/72 in) to the unit.
pDispPrec
[out] Returns precision(number of digits after decimal point) for displaying values of the unit.

Return Value

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

See Also

IPXV_Inst