LINEPROXYREQUEST

typedef struct lineproxyrequest_tag {
    DWORD dwSize;
    DWORD dwClientMachineNameSize;
    DWORD dwClientMachineNameOffset;
    DWORD dwClientUserNameSize;
    DWORD dwClientUserNameOffset;
    DWORD dwClientAppAPIVersion;
    DWORD dwRequestType;
  union {
   struct {
    DWORD dwAddressID;
      LINEAGENTGROUPLIST GroupList;
      } SetAgentGroup;
   struct {
    DWORD dwAddressID;
    DWORD dwAgentState;
    DWORD dwNextAgentState;
      } SetAgentState;
   struct {
    DWORD dwAddressID;
    DWORD dwActivityID;
      } SetAgentActivity;
   struct {
    DWORD dwAddressID;
      LINEAGENTCAPS AgentCaps;
      } GetAgentCaps;
   struct {
    DWORD dwAddressID;
      LINEAGENTSTATUS AgentStatus;
      } GetAgentStatus;
   struct {
    DWORD dwAddressID;
    DWORD dwAgentExtensionIDIndex;
    DWORD dwSize;
      BYTE Params[1];
      } AgentSpecific;
   struct {
    DWORD dwAddressID;
      LINEAGENTACTIVITYLIST ActivityList;
      } GetAgentActivityList;
   struct {
    DWORD dwAddressID;
      LINEAGENTGROUPLIST GroupList;
      } GetAgentGroupList;
  };
} LINEPROXYREQUEST, FAR *LPLINEPROXYREQUEST;

Members

dwSize

The total number of bytes allocated by TAPI to contain the LINEPROXYREQUEST structure. The dwTotalSize member of any structure contained within LINEPROXYREQUEST (for example, LINEAGENTCAPS) reflects only the number of bytes allocated for that specific structure.

dwClientMachineNameSize

dwClientMachineNameOffset

Size in bytes (including the terminating NULL) and offset from the beginning of LINEPROXYREQUEST of a NULL-terminated string identifying the client machine that made this request.

dwClientUserNameSize

dwClientUserNameOffset

Size in bytes (including the terminating NULL) and offset from the beginning of LINEPROXYREQUEST of a NULL-terminated string identifying the user under whose account the application is running on the client machine.

dwClientAppAPIVersion

The global (highest) API version supported by the application that made the request. The proxy handler should restrict the contents of any data returned to the application to those members and values that were defined in this, or earlier, versions of TAPI.

dwRequestType

One of the LINEPROXYREQUEST_ constants. Identifies the type of function and the union component that defines the remaining data in the structure.

SetAgentGroup

The union component used when dwRequestType is LINEPROXYREQUEST_SETAGENT.

dwAddressID: The identifier of the address for which the agent is to be set.
GroupList: A structure of type LINEAGENTGROUPLIST. Offsets within this structure are relative to the beginning of SetAgentGroup.GroupList rather than to the beginning of the LINEPROXYREQUEST structure.

SetAgentState

The union component used when dwRequestType is LINEPROXYREQUEST_SETAGENTSTATE.

dwAddressID: The identifier of the address for which the agent state is to be set.
dwAgentState: The new agent state, or zero to leave the agent state unchanged.
dwNextAgentState: The new next agent state, or zero to use the default next state associated with the specified agent state.

SetAgentActivity

The union component used when dwRequestType is LINEPROXYREQUEST_SETAGENTACTIVITY.

dwAddressID: The identifier of the address for which the agent activity is to be set.
dwActivityID: The identifier for the activity being selected.

GetAgentCaps

The union component used when dwRequestType is LINEPROXYREQUEST_GETAGENTCAPS.

dwAddressID: The identifier of the address for which the agent capabilities are to be retrieved.
AgentCaps: A structure of type LINEAGENTCAPS. Offsets within this structure are relative to the beginning of GetAgentCaps.AgentCaps rather than to the beginning of the LINEPROXYREQUEST structure. The dwTotalSize member is set by TAPI and the remaining bytes set to zero. The proxy handler must fill in dwNeededSize, dwUsedSize, and the remaining members as appropriate, before calling lineProxyResponse.

GetAgentStatus

The union component used when dwRequestType is LINEPROXYREQUEST_SETAGENTGROUP.

dwAddressID: The identifier of the address for which the agent status is to be retrieved.
AgentStatus: A structure of type LINEAGENTSTATUS. Offsets within this structure are relative to the beginning of GetAgentStatus.AgentStatus rather than to the beginning of the LINEPROXYREQUEST structure. The dwTotalSize member is set by TAPI and the remaining bytes set to zero. The proxy handler must fill in dwNeededSize, dwUsedSize, and the remaining members as appropriate, before calling lineProxyResponse.

AgentSpecific

The union component used when dwRequestType is LINEPROXYREQUEST_AGENTSPECIFIC.

dwAddressID: The identifier of the address for which the agent status is to be retrieved.
dwAgentExtensionIDIndex: The index of the handler extension being invoked; the identifier's position within the array of extension identifiers returned in LINEAGENTCAPS.
dwSize: The total size in bytes of the Params parameter block.
Params: A block of memory that includes the contents passed to the handler from the application. If the handler is to return data to the application, it must be written into this parameter block before calling lineProxyResponse.

GetAgentActivityList

The union component used when dwRequestType is LINEPROXYREQUEST_GETAGENTACTIVITYLIST.

dwAddressID: The identifier of the address for which the agent activity list is to be retrieved.
ActivityList: A structure of type LINEAGENTACTIVITYLIST. Offsets within this structure are relative to the beginning of GetAgentActivityList.ActivityList rather than to the beginning of the LINEPROXYREQUEST structure. The dwTotalSize member is set by TAPI and the remaining bytes set to zero. The proxy handler must fill in dwNeededSize, dwUsedSize, and the remaining members as appropriate, before calling lineProxyResponse.

GetAgentGroupList

The union component used when dwRequestType is LINEPROXYREQUEST_GETAGENTGROUPLIST.

dwAddressID: The identifier of the address for which the agent group list is to be retrieved.
GroupList: A structure of type LINEAGENTGROUPLIST. Offsets within this structure are relative to the beginning of GetAgentGroupList.GroupList rather than to the beginning of the LINEPROXYREQUEST structure. The dwTotalSize member is set by TAPI and the remaining bytes set to zero. The proxy handler must fill in dwNeededSize, dwUsedSize, and the remaining members as appropriate, before calling lineProxyResponse.

QuickInfo

Version: Use TAPI version 2.0 and later
Header: Declared in tapi.h.

LINEPROXYREQUEST

Members

QuickInfo

See Also