AV_61883_REQUEST structure (61883.h)
The AV_61883_REQUEST structure is used to pass requests to the IEC-61883 protocol driver.
Syntax
typedef struct _AV_61883_REQUEST {
ULONG Function;
ULONG Version;
ULONG Flags;
union {
GET_UNIT_INFO GetUnitInfo;
SET_UNIT_INFO SetUnitInfo;
CMP_GET_PLUG_HANDLE GetPlugHandle;
CMP_GET_PLUG_STATE GetPlugState;
CMP_CONNECT Connect;
CMP_DISCONNECT Disconnect;
CIP_ATTACH_FRAME AttachFrame;
CIP_CANCEL_FRAME CancelFrame;
CIP_TALK Talk;
CIP_LISTEN Listen;
CIP_STOP Stop;
FCP_REQUEST Request;
FCP_RESPONSE Response;
FCP_SEND_REQUEST SendRequest;
FCP_GET_RESPONSE GetResponse;
FCP_GET_REQUEST GetRequest;
FCP_SEND_RESPONSE SendResponse;
SET_FCP_NOTIFY SetFcpNotify;
CMP_CREATE_PLUG CreatePlug;
CMP_DELETE_PLUG DeletePlug;
CMP_SET_PLUG SetPlug;
BUS_RESET_NOTIFY BusResetNotify;
SET_UNIT_DIRECTORY SetUnitDirectory;
CMP_MONITOR_PLUGS MonitorPlugs;
};
} AV_61883_REQUEST, *PAV_61883_REQUEST;
Members
Function
Determines the type of request. Each request type is documented under the value of Function in IEC-61883 Protocol I/O Requests.
Version
The device driver interface (DDI) version for the request. The INIT_61883_HEADER macro initializes Version to CURRENT_61883_DDI_VERSION.
Flags
Flags specific to the request. For details, see the reference page for the request. Drivers must set this member to zero for requests that do not use flags.
GetUnitInfo
A GET_UNIT_INFO structure, used if the Function member is Av61883_GetUnitInfo.
SetUnitInfo
A SET_UNIT_INFO structure, used if the Function member is Av61883_SetUnitInfo.
GetPlugHandle
A CMP_GET_PLUG_HANDLE structure, used if the Function member is Av61883_GetPlugHandle.
GetPlugState
A CMP_GET_PLUG_STATE structure, used if the Function member is Av61883_GetPlugState.
Connect
A CMP_CONNECT structure, used if the Function member is Av61883_Connect.
Disconnect
A CMP_DISCONNECT structure, used if the Function member is Av61883_Disconnect.
AttachFrame
A CIP_ATTACH_FRAME structure, used if the Function member is Av61883_AttachFrame.
CancelFrame
A CIP_CANCEL_FRAME structure, used if the Function member is Av61883_CancelFrame.
Talk
A CIP_TALK structure, used if the Function member is Av61883_Talk.
Listen
A CIP_LISTEN structure, used if the Function member is Av61883_Listen.
Stop
A CIP_STOP structure, used if the Function member is Av61883_Stop.
Request
An FCP_SEND_REQUEST structure, used if the Function member is Av61883_SendFcpResponse.
Response
An FCP_GET_RESPONSE structure, used if the Function member is Av61883_GetFcpResponse.
SendRequest
An FCP_SEND_REQUEST structure, used if the Function member is Av61883_SendFcpResponse.
GetResponse
An FCP_GET_RESPONSE structure, used if the Function member is Av61883_GetFcpResponse.
GetRequest
An FCP_GET_REQUEST structure, used if the Function member is Av61883_GetFcpRequest.
SendResponse
An FCP_SEND_RESPONSE structure, used if the Function member is Av61883_SendFcpResponse.
SetFcpNotify
A SET_FCP_NOTIFY structure, used if the Function member is Av61883_SetFcpNotify.
CreatePlug
A CMP_CREATE_PLUG structure, used if the Function member is Av61883_CreatePlug.
DeletePlug
A CMP_DELETE_PLUG structure, used if the Function member is Av61883_DeletePlug.
SetPlug
A CMP_SET_PLUG structure, used if the Function member is Av61883_SetPlug.
BusResetNotify
A BUS_RESET_NOTIFY structure, used if the Function member is Av61883_BusResetNotify.
SetUnitDirectory
A SET_UNIT_DIRECTORY structure, used if the Function member is Av61883_SetUnitDirectory.
MonitorPlugs
A CMP_MONITOR_PLUGS structure, used if the Function member is Av61883_MonitorPlugs.
Remarks
The Parameters->Others.Arguments1 member of an IOCTL_61883_CLASS IRP points to an AV_61883_REQUEST structure. The IEC-61883 protocol driver uses the request structure to determine the type of request made by the client driver, and also to return the results of the operation. See IEC-61883 Protocol I/O Requests for a description of the behavior of each request.
Requirements
| Requirement | Value |
|---|---|
| Header | 61883.h (include 61883.h) |