Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IInkStrokeDisp::GetPacketDescriptionPropertyMetrics method

Applies to: desktop apps only

Retrieves the metrics for a given packet description type.

Syntax

HRESULT GetPacketDescriptionPropertyMetrics(
  [in]   BSTR PropertyName,
  [out]  long *Minimum,
  [out]  long *Maximum,
  [out]  TabletPropertyMetricUnit *Units,
  [out]  float *Resolution
);

Parameters

PropertyName [in]

The globally unique identifier (GUID) from the PacketProperty constants that identifies the property for which to obtain metrics.

For more information about the BSTR data type, see Using the COM Library.

Minimum [out]

The minimum value, in logical units, that the tablet reports for this property. For example, a tablet reporting x-values from 0 to 9000 would have a logical minimum of 0.

Maximum [out]

The maximum value, in logical units, that the tablet reports for this property. For example, a tablet reporting x-values from 0 to 9000 would have a logical maximum of 9000.

Units [out]

The physical units of the property, such as inches or degrees. For a list of property units, see the TabletPropertyMetricUnit enumeration type.

Resolution [out]

The resolution or increment value for the units member. For example, a tablet that reports 400 dots per inch (dpi) would have a resolution value of 400.

Return value

This method can return one of these values.

Return codeDescription
S_OK

Success.

E_POINTER

A parameter contained an invalid pointer.

E_OUTOFMEMORY

Cannot allocate memory necessary to complete this request.

CO_E_CLASSSTRING

Invalid GUID format.

E_INVALIDARG

The property does not exist in the collection.

E_INK_EXCEPTION

An exception occurred while processing.

 

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

IInkStrokeDisp Interface
GetPacketValuesByProperty Method
SetPacketValuesByProperty Method
GetPropertyMetrics Method
TabletPropertyMetricUnit Enumeration

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.