Share via

Av61883_GetPlugState control code

  • Article

The Av61883_GetPlugState request retrieves state information for the specified plug, including its current connections and bus data format. Plug state is volatile and can change unexpectedly. The relevant members of the AV_61883_REQUEST structure for this request are:

typedef struct _AV_61883_REQUEST {
  ULONG Function;
  union {
    typedef struct _CMP_GET_PLUG_STATE {
      IN HANDLE  hPlug;
      OUT ULONG  State;
      OUT ULONG  DataRate;
      OUT ULONG  Payload;
      OUT ULONG  BC_Connections;
      OUT ULONG  PP_Connections;
    } CMP_GET_PLUG_STATE, *PCMP_GET_PLUG_STATE;
    .
    .
    .
  };
} AV_61883_REQUEST, *PAV_61883_REQUEST;

Input Buffer

AV_61883_REQUEST Input

  • Function
    Av61883_GetPlugState

  • hPlug
    The handle of the plug to retrieve state information.

Output Buffer

AV_61883_REQUEST Output

  • State
    The state of the plug. Can be one of the following:

    CMP_PLUG_STATE_IDLE

    CMP_PLUG_STATE_READY

    CMP_PLUG_STATE_SUSPENDED

    CMP_PLUG_STATE_ACTIVE

  • DataRate
    The data rate of the plug. Can be one of the following:

    CMP_SPEED_S100

    CMP_SPEED_S200

    CMP_SPEED_S400

  • Payload
    The payload size for the plug.

  • BC_Connections
    The number of broadcast connections associated with the plug.

  • PP_Connections
    The number of point-to-point connections associated with the plug.

Status block

If successful, the IEC-61883 protocol driver sets Irp->IoStatus.Status to STATUS_SUCCESS.

If an incorrect parameter is passed in, the protocol driver sets Irp->IoStatus.Status to STATUS_INVALID_PARAMETER.

Requirements

Header

 61883.h (include 61883.h)

See also

AV_61883_REQUEST

Av61883_CreatePlug

Av61883_Connect

 

 

Send comments about this topic to Microsoft