IPXV_Inst::GetMeasureUnitInfo Method

From PDF XChange PDF SDK
Jump to: navigation, search
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 GetMeasureUnitInfo([in]  MeasureUnit  nUnit,
+
<pre class="brush:cpp;gutter:false">HRESULT GetMeasureUnitInfo([in]  MeasureUnit  Unit,
                           [out]  BSTR*        sName,
+
                           [out]  BSTR*        Name,
                           [out]  BSTR*        sShortName,
+
                           [out]  BSTR*        ShortName,
                           [out]  double*      nPt2UnitCoef,
+
                           [out]  double*      Pt2UnitCoef,
                           [out]  LONG*        nDispPrec);</pre>
+
                           [out]  LONG*        DispPrec);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nUnit
+
;Unit
 
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
 
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
;sName
+
;Name
 
:[out]  Returns display-name of unit.
 
:[out]  Returns display-name of unit.
;sShortName
+
;ShortName
 
:[out]  Returns short display-name of unit.
 
:[out]  Returns short display-name of unit.
;nPt2UnitCoef
+
;Pt2UnitCoef
 
:[out]  Returns translation coefficient from points(1/72 in) to the unit.
 
:[out]  Returns translation coefficient from points(1/72 in) to the unit.
;nDispPrec
+
;DispPrec
 
:[out]  Returns precision(number of digits after decimal point) for displaying values of the unit.
 
:[out]  Returns precision(number of digits after decimal point) for displaying values of the unit.
  

Revision as of 07:32, 12 June 2015


Gets information about specified unit of measurement.

Syntax

HRESULT GetMeasureUnitInfo([in]   MeasureUnit  Unit,
                           [out]  BSTR*        Name,
                           [out]  BSTR*        ShortName,
                           [out]  double*      Pt2UnitCoef,
                           [out]  LONG*        DispPrec);

Parameters

Unit
[in] Value of MeasureUnit.
Name
[out] Returns display-name of unit.
ShortName
[out] Returns short display-name of unit.
Pt2UnitCoef
[out] Returns translation coefficient from points(1/72 in) to the unit.
DispPrec
[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