DiMgslDlWait

Prototype
`NTSTATUS DiMgslDlWait( void Handle, MGSL_DLPRIMITIVE Primitive );`
Parameters
`Handle`	Handle to open port
`Primitive`	Pointer to `MGSL_DLPRIMITIVE` structure to hold returned confirm or indication primitive.
Return Value
`STATUS_SUCCESS`	An indication or confirm primitive has been returned
`STATUS_INVALID_HANDLE`	Handle or Link field of Primitive is invalid
`STATUS_INVALID_PARAMETER`	The Primitive parameter is invalid.
`STATUS_RETRY`	No indication or confirm primitives are available. The DlReady callback function in the client driver is called when such a primitive becomes available.

Poll for and return the next available CONFIRM or INDICATION primitive. The returned primitive can be associated with any link instance allocated for the specified device.

Before making this call, initialize the Size member of the primitive structure to the total size in bytes of the Buffer member. The contents of other structure members are ignored.

If an error code other than STATUS_SUCCESS is returned, no primitive is returned in the primitive structure.

If all arguments are valid and a primitive is available, STATUS_SUCCESS is returned. Otherwise STATUS_RETRY is returned and the API calls the DlReady callback function in the client driver when a primitive becomes available.

If the next available primitive contains more data than can fit in the Buffer member of the primitive structure, then the Type member is set to DLERROR_INSUFFICIENT_BUFFER. A larger buffer must be allocated, and this function called again to retrieve the primitive.

When returning a CONFIRM or INDICATION primitive, the Link member is set to the link instance identifier associated with the primitive. The Type field identifies the primitive type. The Flags, Size, and Buffer members may contain additional, primitive specific information. If the Flags field is unused, it will be set to 0. If the Buffer member is unused or empty, Size will be set to zero.

Contents