Call Data (number of bytes varies with the value of Action)

The combination of the Length field value and Action field values define the Call Data area size, format, and field definitions. The valid Call Data formats supported by this interface are defined as follows:

Length=8

Action=1. Pre-session save. Call Data contains the following fields to represent the outgoing session information:

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄ¿
³Field                    ³Length ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session Type             ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session ID               ³WORD   ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÙ

Action=2. Post-session save. Call Data contains the following fields to represent the changing (incoming and outgoing Session IDs) session information:

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄ¿
³Field                    ³Length ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session ID In            ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session ID Out           ³WORD   ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÙ

Action=4. Post-session restore. Call Data contains the following fields to represent the restored (incoming) session information:

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄ¿
³Field                    ³Length ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session ID               ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session Type             ³WORD   ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÙ

Action=8. Session termination. Call Data contains the following fields to represent the terminating session information:

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄ¿
³Field                    ³Length ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session Type             ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session ID               ³WORD   ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÙ

Action=16. Session creation. Call Data contains the following fields to represent the newly created session information:

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄ¿
³Field                    ³Length ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session ID               ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session Type             ³WORD   ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÙ

Length=12

Action=32. Start of session switch. Call Data contains the following fields to represent session-switching (incoming and outgoing session) information:

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄ¿
³Field                    ³Length ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session In ID            ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session In Type          ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session Out ID           ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session Out Type         ³WORD   ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÙ

Action=64. End of session switch. Call Data contains the following fields to represent session-switching information:

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄ¿
³Field                    ³Length ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session In ID            ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session In Type          ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session Out ID           ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³Session Out Type         ³WORD   ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÙ

Length=24

Action=128. AIM pre-save verify. This type of notification is issued to device drivers to verify that the new AIM parameters are valid. The new values are not actually set until the AIM post-save activate notification.

Action=256. AIM post-save activate. The Call Data area format for Length=24 (all Action values) is defined as follows:

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄ¿
³Field                    ³Length ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³AIM_Errors               ³DWORD  ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³AIM_Active               ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³AIM_Timeout              ³WORD   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³AIM_FKAccept             ³DWORD  ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³AIM_FKRate               ³DWORD  ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄ´
³AIM_FKDelay              ³DWORD  ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÙ

AIM_Errors

Contains a return bit mask that identifies the specific AIM parameter value/field that caused an error condition. A set bit (value of 1) indicates an error. The AIM_Errors bit definitions are as follows:

Bits 31-5

Reserved. Must equal 0.
Bit 4
Set, if AIM_FKDelay value error
Bit 3
Set, if AIM_FKRate value error
Bit 2
Set, if AIM_FKAccept value error
Bit 1
Set, if AIM_Timeout value error
Bit 0
Set, if AIM_Active value error
Note: Device drivers performing AIM parameter validation must do so on the pre-save notification calls. Error return codes are not meaningful and are not returned on AIM post-save notification calls.
AIM_Active
Contains the Special Needs Status flag. Possible AIM_Active values are:
• Indicates that AIM Support is currently inactive (FALSE).

• Indicates that AIM Support is currently active (TRUE).
AIM_Timeout
Contains the number of seconds that the Special Needs methods should remain active once keyboard usage has ceased. A value of 0 indicates no timeout.
AIM_FKAccept
Contains the number of milliseconds a key must be pressed in order for it to be recognized as a key press event. A value of 0 indicates that no additional time is applied to the standard hardware response time.
AIM_FKRate
Indicates the number of milliseconds between recognized typematic key press events when a key is held down. A value of 0 indicates that no additional time is applied to the standard hardware rate.
AIM_FKDelay
Contains the number of milliseconds that a key press must be held down before generating typematic support with AIM_FKRate. A value of 0 indicates typematic keystroke support is disabled.

---

[Back] [Next]