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  Unit,
+
<pre class="brush:cpp;gutter:false">HRESULT GetMeasureUnitInfo([in]  MeasureUnit  nUnit,
                           [out]  BSTR*        Name,
+
                           [out]  BSTR*        sName,
                           [out]  BSTR*        ShortName,
+
                           [out]  BSTR*        sShortName,
                           [out]  double*      Pt2UnitCoef,
+
                           [out]  double*      nPt2UnitCoef,
                           [out]  LONG*        DispPrec);</pre>
+
                           [out]  LONG*        nDispPrec);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Unit
+
;nUnit
 
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
 
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
;Name
+
;sName
 
:[out]  Returns display-name of unit.
 
:[out]  Returns display-name of unit.
;ShortName
+
;sShortName
 
:[out]  Returns short display-name of unit.
 
:[out]  Returns short display-name of unit.
;Pt2UnitCoef
+
;nPt2UnitCoef
 
:[out]  Returns translation coefficient from points(1/72 in) to the unit.
 
:[out]  Returns translation coefficient from points(1/72 in) to the unit.
;DispPrec
+
;nDispPrec
 
:[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.
  

Latest revision as of 03:56, 15 June 2015


Gets information about specified unit of measurement.

Syntax

HRESULT GetMeasureUnitInfo([in]   MeasureUnit  nUnit,
                           [out]  BSTR*        sName,
                           [out]  BSTR*        sShortName,
                           [out]  double*      nPt2UnitCoef,
                           [out]  LONG*        nDispPrec);

Parameters

nUnit
[in] Value of MeasureUnit.
sName
[out] Returns display-name of unit.
sShortName
[out] Returns short display-name of unit.
nPt2UnitCoef
[out] Returns translation coefficient from points(1/72 in) to the unit.
nDispPrec
[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