Edit

PacketPropertyGuids Constants

  • Article

Defines values that specify the packet properties. The Tablet PCAPI uses globally unique identifiers (GUIDs) to identify packet properties, which in COM are constant strings.

In C++, you can access these constants in the Msinkaut.h header file, which is located in the <systemdrive>:\Program Files\Microsoft SDKs\Windows\v6.0\Include directory if you installed the SDK in the default location. In C++, these constants are WCHARs, not BSTRs. Convert them into BSTRs before use. For more information about the BSTR data type, see Using the COM Library.

The following table lists the available packet property globally unique identifier (GUID) fields. Use these GUIDs to specify which properties the packet contains when you create the tablet context. To determine the range and resolution of a property, call the GetPropertyMetrics method. The constants in the table below beginning with "STR_" are string representations of the corresponding binary constants shown in the same table cell.

Constant Description
STR_GUID_X or GUID_PACKETPROPERTY_GUID_X
 The x-coordinate in the tablet coordinate space. Each packet contains this property by default. The origin (0,0) of the tablet is the upper-left corner.
STR_GUID_Y or GUID_PACKETPROPERTY_GUID_Y
 The y-coordinate in the tablet coordinate space. Each packet contains this property by default. The origin (0,0) of the tablet is the upper-left corner.
STR_GUID_Y or GUID_PACKETPROPERTY_GUID_Y
 The y-coordinate in the tablet coordinate space. Each packet contains this property by default. The origin (0,0) of the tablet is the upper-left corner.
STR_GUID_Z or GUID_PACKETPROPERTY_GUID_Z
 The z-coordinate or distance of the pen tip from the tablet surface. The TabletPropertyMetricUnit enumeration type determines the unit of measurement for this property.
STR_GUID_PAKETSTATUS or GUID_PACKETPROPERTY_GUID_PACKET_STATUS
 Contains one or more of the following flag values:
  • The cursor is touching the drawing surface (Value = 1).
  • The cursor is inverted. For example, the eraser end of the pen is pointing toward the surface (Value = 2).
  • Not used (Value = 4).
  • The barrel button is pressed (Value = 8).
STR_GUID_TIMERTICK or GUID_PACKETPROPERTY_GUID_TIMER_TICK
 The time the packet was generated.
STR_GUID_TIMERTICK or GUID_PACKETPROPERTY_GUID_TIMER_TICK
 The time the packet was generated.
STR_GUID_SERIALNUMBER or GUID_PACKETPROPERTY_GUID_SERIAL_NUMBER
 The packet property for identifying the packet.
This is the same value you use to retrieve the packet from the packet queue.
STR_GUID_NORMALPRESSURE or GUID_PACKETPROPERTY_GUID_NORMAL_PRESSURE
 The pressure of the pen tip perpendicular to the tablet surface.
The greater the pressure on the pen tip, the more ink that is drawn.
STR_GUID_TANGENTPRESSURE or GUID_PACKETPROPERTY_GUID_TANGENT_PRESSURE
 The pressure of the pen tip along the plane of the tablet surface.
STR_GUID_BUTTONPRESSURE or GUID_PACKETPROPERTY_GUID_BUTTON_PRESSURE
 The pressure on a pressure sensitive button.
STR_GUID_XTILTORIENTATION or GUID_PACKETPROPERTY_GUID_X_TILT_ORIENTATION
 The angle between the y,z-plane and the pen and y-axis plane.
Applies to a pen cursor.
The value is 0 when the pen is perpendicular to the drawing surface and is positive when the pen is to the right of perpendicular.
STR_GUID_YTILTORIENTATION or GUID_PACKETPROPERTY_GUID_Y_TILT_ORIENTATION
 The angle between the x,z-plane and the pen and x-axis plane.
Applies to a pen cursor.
The value is 0 when the pen is perpendicular to the drawing surface and is positive when the pen is upward or away from the user.
STR_GUID_AZIMUTHORIENTATION or GUID_PACKETPROPERTY_GUID_AZIMUTH_ORIENTATION
 The clockwise rotation of the cursor about the z-axis through a full circular range.
STR_GUID_ALTITUDEORIENTATION or GUID_PACKETPROPERTY_GUID_ALTITUDE_ORIENTATION
 The angle between the axis of the pen and the surface of the tablet.
The value is 0 when the pen is parallel to the surface and 90 when the pen is perpendicular to the surface.
The values are negative when the pen is inverted.
STR_GUID_TWISTORIENTATION or GUID_PACKETPROPERTY_GUID_TWIST_ORIENTATION
 The clockwise rotation of the cursor about its own axis.
STR_GUID_PITCHROTATION or GUID_PACKETPROPERTY_GUID_PITCH_ROTATION
 The packet property that indicates whether the tip is above or below a horizontal line that is perpendicular to the writing surface.
Note: This requires a 3D digitizer.
The value is positive if the tip is above the line and negative if it is below the line. For example, if you hold the pen in front of you and write on an imaginary wall, the pitch is positive if the tip is above a line extending from you to the wall.
STR_GUID_ROLLROTATION or GUID_PACKETPROPERTY_GUID_ROLL_ROTATION
 The clockwise rotation of the pen around its own axis.
Note: This requires a 3D digitizer.
STR_GUID_YAWROTATION or GUID_PACKETPROPERTY_GUID_YAW_ROTATION
 The angle of the pen to the left or right around the center of its horizontal axis when the pen is horizontal.
Note: This requires a 3D digitizer.
If you hold the pen in front of you and write on an imaginary wall, zero yaw indicates that the pen is perpendicular to the wall. The value is negative if the tip is to the left of perpendicular and positive if the tip is to the right of perpendicular.
STR_GUID_YAWROTATION or GUID_PACKETPROPERTY_GUID_YAW_ROTATION
 The angle of the pen to the left or right around the center of its horizontal axis when the pen is horizontal.
Note: This requires a 3D digitizer.
If you hold the pen in front of you and write on an imaginary wall, zero yaw indicates that the pen is perpendicular to the wall. The value is negative if the tip is to the left of perpendicular and positive if the tip is to the right of perpendicular.
STR_GUID_WIDTH or GUID_PACKETPROPERTY_GUID_WIDTH
 The width of the contact area on a touch digitizer.
STR_GUID_HEIGHT or GUID_PACKETPROPERTY_GUID_HEIGHT
 The height of the contact area on a touch digitizer.
STR_GUID_FINGERCONTACTCONFIDENCE or GUID_PACKETPROPERTY_GUID_FINGERCONTACTCONFIDENCE
 The level of confidence that there was finger contact on a touch digitizer.
STR_GUID_DEVICE_CONTACT_ID or GUID_PACKETPROPERTY_GUID_DEVICE_CONTACT_ID
 The device contact identifier for a packet.

Remarks

Note

All packet values coming from the tablet hardware are 32-bit size integers.

 

Requirements

Requirement Value
Minimum supported client
 Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server
 None supported
Header
Msinkaut.h (also requires Msinkaut_i.c)

See also

IsPacketPropertySupported Method

GetPropertyMetrics Method

IInkTablet Interface