NdisConvertStringToAtmAddress function

Article
06/19/2017

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.

NdisConvertStringToAtmAddress converts a Unicode string that contains an ATM address into a ATM_ADDRESS structure that a connection-oriented client can include in a set of call parameters.

Syntax

VOID NdisConvertStringToAtmAddress(
  _Out_ PNDIS_STATUS Status,
  _In_  PNDIS_STRING String,
  _Out_ PATM_ADDRESS AtmAddress
);

Parameters

Status [out]
Pointer to a caller-supplied variable in which this function returns the status of the conversion. Possible return values are:
- NDIS_STATUS_SUCCESS
  The conversion was successful.
- NDIS_STATUS_INVALID_LENGTH
  The ATM address in String did not have the correct length.
- NDIS_STATUS_RESOURCES
  NDIS could not allocate the resources it needed to make the conversion.
- NDIS_STATUS_FAILURE
  The string could not be converted to a valid ATM address.
String [in]
Pointer to an NDIS_STRING type that describes a caller-supplied Unicode string that specifies the ATM address to be converted. For Windows 2000 and later, NDIS defines the NDIS_STRING type as a UNICODE_STRING type.
AtmAddress [out]
Pointer to a caller-allocated buffer in which this routine returns an ATM address formatted as an ATM_ADDRESS structure, defined as follows:
```
typedef struct _ATM_ADDRESS {
    ATM_ADDRESSTYPE  AddressType;
    ULONG            NumberOfDigits;
    UCHAR            Address[ATM_ADDRESS_LENGTH];
} ATM_ADDRESS, *PATM_ADDRESS;
```
The members of this structure contain the following data:
- AddressType
  Specifies the format of the ATM address. A value of ATM_NSAP specifies an ATM Endstation Address (NSAP format). A value of ATM_E164 specifies an E.164 address (telephony format).
- NumberOfDigits
  Indicates the number of digits in the ATM address.
- Address[ATM_ADDRESS_LENGTH]
  An array that contains the converted ATM address.

Return value

None

Remarks

A connection-oriented client calls NdisConvertStringToAtmAddress to convert a ATM address in a Unicode string to an ATM_ADDRESS structure. Typically, the client retrieved the input ATM address string from the registry.

If the conversion is successful, NdisConvertStringToAtmAddress returns the converted ATM address without punctuation, formatted as an ATM_ADDRESS structure. In addition to providing the converted ATM address, the ATM_ADDRESS structure also indicates the address type and the number of digits in the address.

The client uses the converted ATM address when creating a set of call parameters, which the client subsequently passes as an argument to various NdisClXxx functions.

Requirements

Target platform	Desktop
Version	Not supported for NDIS 6.0 drivers in Windows Vista. Supported for NDIS 5.1 drivers in Windows Vista and Windows XP.
Header	Ndis.h (include Ndis.h)
IRQL	PASSIVE_LEVEL.

Share via