CO_SAP structure

Note   NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.

The CO_SAP structure specifies a Service Access Point (SAP) on which a connection-oriented client can receive incoming calls.

Syntax

typedef struct {
  ULONG SapType;
  ULONG SapLength;
  UCHAR Sap[1];
} CO_SAP, *PCO_SAP;

Members

  • SapType
    Specifies the format of the SAP address:

    Value Meaning
    NSAP

    Specifies an OSI SAP, which is a 20-octet hexadecimal address.

    E164

    Specifies an E.164 SAP, which is a 0-15-digit decimal address.

    AF_TAPI_SAP_TYPE

    Specifies a SAP used for TAPI calls.

     

  • SapLength
    Specifies the size in bytes of the structure at Sap.

  • Sap
    Specifies a variable-length array that contains the SAP information. The number and type of elements is defined by the call manager for the address family opened by the client.

Remarks

A connection-oriented client registers a SAP with a call manager by passing a CO_SAP structure in a call to NdisClRegisterSap. NDIS forwards the SAP information to the call manager's ProtocolCmRegisterSap function for validation. The SAP format is medium-dependent and specific to the address family supported by the call manager. If the SAP is already in use or if the call manager does not recognize the client-supplied specification at Sap, ProtocolCmRegisterSap fails the call, and NdisClRegisterSap propagates the failure back to the client.

After a client has successfully registered a SAP, the call manager notifies the client of incoming calls on that SAP. A client can register more than one SAP with a call manager.

SapType is meaningful only to the client and to the call manager or integrated miniport driver call manager (MCM) driver with which the client registers the SAP. The client can therefore set SapType to a driver-defined value that is recognized by the call manager or MCM driver.

Requirements

Header

Ndis.h (include Ndis.h)

See also

NdisClRegisterSap

ProtocolClRegisterSapComplete

ProtocolCmRegisterSap

 

 

Send comments about this topic to Microsoft