NDIS_TAPI_GET_DEV_CONFIG (Compact 2013)

3/26/2014

The NDIS_TAPI_GET_DEV_CONFIG structure describes the current configuration of a device associated one-to-one with a particular line. OID_TAPI_GET_DEV_CONFIG requests this information from the miniport driver.

Support for this request is mandatory.

Syntax

typedef struct _NDIS_TAPI_GET_DEV_CONFIG { 
  ULONG ulRequestID; 
  ULONG ulDeviceID; 
  ULONG ulDeviceClassSize; 
  ULONG ulDeviceClassOffset; 
  VAR_STRING DeviceConfig; 
} NDIS_TAPI_GET_DEV_CONFIG, *PNDIS_TAPI_GET_DEV_CONFIG; 

Members

• ulRequestID
  [in] Reserved.

• ulDeviceID
  [in] Specifies the line device to be queried. This value was set up in a preceding OID_TAPI_PROVIDER_INITIALIZE request.

• ulDeviceClassSize
  [in] Specifies the number of bytes in the device-class string.

• ulDeviceClassOffset
  [in] Specifies the offset in bytes to the zero-terminated, variable-size counted string specifying the class of the device whose configuration is requested. Valid device class strings are the same as those specified for the OID_TAPI_GET_ID request when it is applied to a line device (ulSelect has the value LINECALLSELECT_LINE).

• DeviceConfig
  [out] Specifies the virtual address of a structure of type VAR_STRING to contain the device configuration information for the associated device.

  The ulStringFormat member of the VAR_STRING structure must be set to STRINGFORMAT_BINARY.

  The miniport driver fills this structure with the device configuration information to complete this request successfully.

  In general, the contents of the NDIS_TAPI_GET_DEV_CONFIG structure are specific to the NIC driver's line and the device class.

Remarks

The MiniportQueryInformation function can return one of the following:

• NDIS_STATUS_SUCCESS
• NNDIS_STATUS_TAPI_INVALDEVICECLASS
• NDIS_STATUS_TAPI_STRUCTURETOOSMALL
• NDIS_STATUS_TAPI_NODRIVER
• NDIS_STATUS_TAPI_RESOURCEUNAVAIL
• NDIS_STATUS_FAILURE

Requirements

Header

ndistapi.h, ntddndis.h

See Also

Reference

NDIS 5.x Legacy Structures
OID_TAPI_GET_DEV_CONFIG
OID_TAPI_PROVIDER_INITIALIZE
OID_TAPI_GET_ID
MiniportQueryInformation
VAR_STRING