IInkStrokeDisp::GetPacketDescriptionPropertyMetrics method (msinkaut.h)
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
[in] PropertyName
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.
[out] Minimum
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.
[out] Maximum
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.
[out] Units
The physical units of the property, such as inches or degrees. For a list of property units, see the TabletPropertyMetricUnit enumeration type.
[out] Resolution
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 code | Description |
---|---|
|
Success. |
|
A parameter contained an invalid pointer. |
|
Cannot allocate memory necessary to complete this request. |
|
Invalid GUID format. |
|
The property does not exist in the collection. |
|
An exception occurred while processing. |
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows XP Tablet PC Edition [desktop apps only] |
Minimum supported server | None supported |
Target Platform | Windows |
Header | msinkaut.h |
Library | InkObj.dll |
See also
GetPacketValuesByProperty Method