IPXV_Inst::GetMeasureUnitInfo Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::GetMeasureUnitInfo Method}}
 
{{#customTitle:IPXV_Inst::GetMeasureUnitInfo Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|GetMeasureUnitInfo|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets information about specified unit of measurement.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetMeasureUnitInfo([in] MeasureUnit nUnit, [out] BSTR* ppName, [out] BSTR* ppShortName, [out] double* pPt2UnitCoef, [out] LONG* pDispPrec);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetMeasureUnitInfo([in]   MeasureUnit nUnit,
 +
                          [out] BSTR*       sName,
 +
                          [out] BSTR*       sShortName,
 +
                          [out] double*     nPt2UnitCoef,
 +
                          [out] LONG*       nDispPrec);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nUnit''
+
;nUnit
 
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
 
:[in]  Value of [[PXV:MeasureUnit|MeasureUnit]].
;''ppName''
+
;sName
:[out]  Pointer to BSTR.
+
:[out]  Returns display-name of unit.
;''ppShortName''
+
;sShortName
:[out]  Pointer to BSTR.
+
:[out]  Returns short display-name of unit.
;''pPt2UnitCoef''
+
;nPt2UnitCoef
:[out]  Pointer to double.
+
:[out]  Returns translation coefficient from points(1/72 in) to the unit.
;''pDispPrec''
+
;nDispPrec
:[out]  Pointer to LONG.
+
:[out]  Returns precision(number of digits after decimal point) for displaying values of the unit.
  
 
== Return Value ==
 
== Return Value ==
Line 23: Line 30:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]]

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