OID_PM_GET_PROTOCOL_OFFLOAD

An overlying driver issues an OID method request of OID_PM_GET_PROTOCOL_OFFLOAD to obtain parameter settings for a low power protocol offload from a network adapter.

The InformationBuffer member of the NDIS_OID_REQUEST structure initially contains a pointer to a ULONG protocol offload identifier. After a successful return from the OID method request, the InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to an NDIS_PM_PROTOCOL_OFFLOAD structure.

Remarks

NDIS 6.20 and later protocol drivers use OID_PM_GET_PROTOCOL_OFFLOAD method OID to retrieve parameter settings for a low power protocol offload from a network adapter.

The information buffer must point to a ULONG-type protocol offload identifier. NDIS set this protocol offload identifier in the ProtocolOffloadId member of the NDIS_PM_PROTOCOL_OFFLOAD structure when NDIS sent the prior OID_PM_ADD_PROTOCOL_OFFLOAD OID request to the underlying network adapter.

The miniport driver returns one of the following status codes for the request:

NDIS_STATUS_SUCCESS
The requested data was retrieved successfully. The information buffer contains the corresponding NDIS_PM_PROTOCOL_OFFLOAD structure.

NDIS_STATUS_PENDING
The request is pending completion. The final status code and results will be passed to the OID request completion handler of the caller.

NDIS_STATUS_INVALID_PARAMETER
The specified protocol offload identifier was not valid.

NDIS_STATUS_BUFFER_TOO_SHORT
The information buffer was too short. NDIS set the DATA.QUERY_INFORMATION.BytesNeeded member in the NDIS_OID_REQUEST structure to the minimum buffer size that is required.

NDIS_STATUS_NOT_SUPPORTED
The NDIS version of the miniport driver is below 6.20.

NDIS_STATUS_FAILURE
The request failed for reasons other than the preceding reasons.

Requirements

See also

NDIS_PM_PROTOCOL_OFFLOAD

OID_PM_ADD_PROTOCOL_OFFLOAD