SERIALKEYS - Win32 Programmer's Reference (win32.hlp)

Win32 Programmer's Reference

Index Commented Search About

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
-
Header File
winuser.h
Unicode
WinNT
Platform Notes
None

SERIALKEYS

The SERIALKEYS structure contains information about the SerialKeys accessibility feature, which interprets data from a communication aid attached to a serial port as commands causing the system to simulate keyboard and mouse input.

typedef struct tagSERIALKEYS { // sk

DWORD cbSize;

DWORD dwFlags;

LPSTR lpszActivePort;

LPSTR lpszPort;

DWORD iBaudRate;

DWORD iPortState;

} SERIALKEYS, FAR* LPSERIALKEYS;

Members
cbSize
Specifies the structure size, in bytes.

dwFlags
Specifies a combination of the following values:

Value	Meaning
SERKF_ACTIVE	The SerialKeys feature is currently receiving input on the serial port specified by lpszPort.
SERKF_AVAILABLE	The SerialKeys feature is available.
SERKF_INDICATOR	A visual indicator is displayed when the SerialKeys feature is on. This value is not currently used and is ignored.
SERKF_SERIALKEYSON	The SerialKeys feature is on.

lpszActivePort
Points to a string that contains the name of the serial port that receives input from the communication aid when the SerialKeys feature is on. If no port is being used, this member is NULL. If this member is "Auto", the system watches all unused serial ports for input from communication aids.

lpszPort
Reserved; must be NULL.

iBaudRate
Specifies the baud rate setting for the serial port specified by the lpszActivePort member. This member should be set to one of the CBR_ values defined in the Windows header files. If lpszActivePort is NULL, this member is zero.

iPortState
Specifies the state of the port specified by the lpszActivePort member. If lpszActivePort is NULL, iPortState is zero; otherwise, it is one of the following values:

Value	Meaning
0	All input on this port is ignored by the SerialKeys feature.
	Input on this port is watched for SerialKeys activation sequences when no other application has the port open.
	All input on this port is treated as SerialKeys commands.

Remarks
An application uses this structure when calling the SystemParametersInfo function with the SPI_GETSERIALKEYS or SPI_SETSERIALKEYS value. When using SPI_GETSERIALKEYS, an application must specify the cbSize, lpszActivePort, and lpszPort members of the SERIALKEYS structure; the SystemParametersInfo function fills the remaining members. An application must specify all structure members when using the SPI_SETSERIALKEYS value.