LINEAGENTSTATUS

The LINEAGENTSTATUS structure describes the current status of an ACD agent. The lineGetAgentStatus function returns the LINEAGENTSTATUS structure.

typedef struct lineagentstatus_tag {
  DWORD  dwTotalSize;
  DWORD  dwNeededSize;
  DWORD  dwUsedSize;

  DWORD  dwNumEntries;
  DWORD  dwGroupListSize;
  DWORD  dwGroupListOffset;

  DWORD  dwState;
  DWORD  dwNextState;
  DWORD  dwActivityID;
  DWORD  dwActivitySize;
  DWORD  dwActivityOffset;

  DWORD  dwAgentFeatures;
  DWORD  dwValidStates;
  DWORD  dwValidNextStates;
} LINEAGENTSTATUS, *LPLINEAGENTSTATUS;

Members

dwTotalSize

The total size, in bytes, allocated to this data structure.

dwNeededSize

The size, in bytes, needed to hold all the information requested.

dwUsedSize

The size, in bytes, of the portion of this data structure that contains useful information.

dwNumEntries

The number of LINEAGENTGROUPENTRY structures that appear in the GroupList array. The value is 0 if no agent is logged in on the address.

dwGroupListSize

dwGroupListOffset

Total size, in bytes, and offset from the beginning of LINEAGENTSTATUS of an array of LINEAGENTGROUPENTRY elements. The size is dwNumEntries times SIZEOF(LINEAGENTGROUPENTRY). The array contains groups into which the agent is currently logged in on the address.

dwState

The current state of the agent. One of the LINEAGENTSTATE_ constants.

dwNextState

The state into which the agent is automatically placed when the current call completes. One of the LINEAGENTSTATE_ constants.

dwActivityID

The identifier of the current agent activity.

dwActivitySize

dwActivityOffset

Size, in bytes, and offset from the beginning of LINEAGENTSTATUS of a null-terminated string specifying the current agent activity.

dwAgentFeatures

The agent-related features available at the time the status was obtained, using the LINEAGENTFEATURE_ constants.

dwValidStates

The agent states that could be selected, at this point in time, using lineSetAgentState. Consists of one or more of the LINEAGENTSTATE_ constants.

dwValidNextStates

The next agent states that could be selected, at this point in time, by calling the lineSetAgentState function. Consists of one or more of the LINEAGENTSTATE_ constants.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later.
  Version: Requires TAPI 2.0 or later.
  Header: Declared in Tapi.h.

See Also

LINEAGENTGROUPENTRY, lineGetAgentStatus