LINEAGENTCAPS
typedef struct lineagentcaps_tag {
DWORD dwTotalSize;
DWORD dwNeededSize;
DWORD dwUsedSize;
DWORD dwAgentHandlerInfoSize;
DWORD dwAgentHandlerInfoOffset;
DWORD dwCapsVersion;
DWORD dwFeatures;
DWORD dwStates;
DWORD dwNextStates;
DWORD dwMaxNumGroupEntries;
DWORD dwAgentStatusMessages;
DWORD dwNumAgentExtensionIDs;
DWORD dwAgentExtensionIDListSize;
DWORD dwAgentExtensionIDListOffset;
} LINEAGENTCAPS, FAR *LPLINEAGENTCAPS;
Members
dwAgentHandlerInfoSize
dwAgentHandlerInfoOffset
The size in
bytes and offset from the beginning of LINEAGENTCAPS of a
null-terminated string specifying the name, version, or other identifying
information of the server application that is handling agent requests.
dwCapsVersion
The TAPI
version that the agent handler application used in preparing the contents of
this structure. This will be no greater than the API version that the calling
application passed in to lineGetAgentCaps.
dwFeatures
The
agent-related features available for this line using the LINEAGENTFEATURE_
constants. Invoking a supported feature requires the line and address to be in
the proper state. A zero in a bit position indicates that the corresponding
feature is never available. A one indicates that the corresponding feature may
be available if the line is in the appropriate state for the operation to be
meaningful. This field allows an application to discover which agent features
can be (and which can never be) supported by the device.
dwStates
The LINEAGENTSTATE_
values which may be used in the dwAgentState parameter of lineSetAgentState. Setting a supported state
requires the line and address to be in the proper state. A zero in a bit
position indicates that the corresponding state is never available. A one
indicates that the corresponding state may be available if the line is in the
appropriate state for the state to be meaningful. This field allows an
application to discover which agent states can be (and which can never be)
supported on the device.
dwNextStates
The
LINEAGENTSTATE_ values which may be used in the dwNextAgentState
parameter of lineSetAgentState. Setting a supported state requires the
line and address to be in the proper state. A zero in a bit position indicates
that the corresponding state is never available. A one indicates that the
corresponding state may be available if the line is in the appropriate state
for the state to be meaningful. This field allows an application to discover
which agent states can be (and which can never be) supported on the device.
dwMaxNumGroupEntries
The maximum
number of agent IDs that can be logged in on the address simultaneously.
Determines the highest value that can be passed in as the dwNumEntries
field in the LINEAGENTGROUPLIST structure to lineSetAgentGroup.
dwAgentStatusMessages
Indicates the
LINEAGENTSTATUS_ constants that can be received by the application in dwParam2
of a LINE_AGENTSTATUS
message.
dwNumExtensionIDs
The number of
LINEEXTENSIONID
structures that appear in the ExtensionIDList array. The value is 0 if
agent-handler-specific extensions are supported on the address.
dwExtensionIDListSize
dwExtensionIDListOffset
Total size in
bytes and offset from the beginning of LINEAGENTCAPS of an array of LINEEXTENSIONID
elements. The size will be dwNumExtensionIDs times SIZEOF (LINEEXTENSIONID).
The array lists the 128-bit universally unique identifiers for all
agent-handler-specific extensions supported by the agent handle for the
address. The extension being used is referenced in the lineAgentSpecific
function and LINE_AGENTSPECIFIC message by its position in this table, the
first entry being entry 0, so it is important that the agent handler always
present extension IDs in this array in the same order.
See Also