GetPenDataAttributes
2.0
Retrieves
information about an HPENDATA object.
int GetPenDataAttributes( HPENDATA hpndt,
LPVOID lpvBuffer, UINT uOption )
Parameters
hpndt
Handle to the
HPENDATA object.
lpvBuffer
Pointer to a
structure whose type depends on uOption, or NULL if the uOption
parameter does not require this buffer.
uOption
Specifies the
attributes to retrieve. This parameter can be one of the following:
|
Constant |
Description |
|
GPA_MAXLEN |
Retrieves
the length (in points) of the longest stroke. lpvBuffer is unused and
ignored. |
|
GPA_POINTS |
Retrieves
the total number of points. lpvBuffer is unused and ignored. |
|
GPA_PDTS |
Retrieves
the PDTS_ bits. lpvBuffer is unused and ignored. |
|
GPA_RATE |
Retrieves
the sampling rate in samples per second. lpvBuffer is unused and
ignored. |
|
GPA_RECTBOUND |
Retrieves
the bounding rectangle of all pen-down points. lpvBuffer is the
address of a RECT
structure. |
|
GPA_RECTBOUNDINK |
Like
GPA_RECTBOUND, retrieves the bounding rectangle of all pen-down points, but
inflates the rectangle to accommodate ink width. lpvBuffer is the
address of a RECT
structure. |
|
GPA_SIZE |
Retrieves
the size of the pen data memory block in bytes. Because of the potential
large size of this value, the return value of the function is not used.
Instead, lpvBuffer is the address of a DWORD variable to fill with the
size. |
|
GPA_STROKES |
Retrieves the
total number of strokes, including pen-up strokes. lpvBuffer is unused
and ignored. |
|
GPA_TIME |
Retrieves
the absolute time of creation of the pen data. lpvBuffer is the
address of an ABSTIME
structure. |
|
GPA_USER |
Retrieves
the number of user bytes available per stroke: 0, 1, 2, or 4. lpvBuffer
is unused and ignored. |
|
GPA_VERSION |
Retrieves
the version number of the pen data. lpvBuffer is unused and ignored. |
Return Value
Returns
PDR_OK or an integer value if successful, depending on the uOption parameter.
Comments
GetPenDataAttributes provides enhancements of some of the capabilities of GetPenDataInfo. It also provides
additional detailed information taken from the HPENDATA block.
See Also