This documentation is archived and is not being maintained.

NdisOpenConfigurationKeyByName (NDIS 5.1) function

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.

NdisOpenConfigurationKeyByName opens a named subkey of a given open registry key designated by a caller-supplied handle.

Syntax


VOID NdisOpenConfigurationKeyByName(
  _Out_ PNDIS_STATUS Status,
  _In_  NDIS_HANDLE  ConfigurationHandle,
  _In_  PNDIS_STRING SubKeyName,
  _Out_ PNDIS_HANDLE SubKeyHandle
);

Parameters

Status [out]

Pointer to a caller-supplied variable in which this function returns the status of its attempt to open the registry key. Possible return values are one of the following:

NDIS_STATUS_SUCCESS

NDIS has initialized accessed to the subkey specified by SubKeyName.

NDIS_STATUS_FAILURE

The key could not be opened.

ConfigurationHandle [in]

The handle to a registry key for which a subkey should be opened. Usually, ConfigurationHandle was returned by NdisOpenConfiguration or NdisOpenProtocolConfiguration.

SubKeyName [in]

Pointer to an NDIS_STRING type containing a caller-supplied, counted string in the system-default character set that specifies the name of the registry subkey to open. For Windows 2000 and later drivers, this string contains Unicode characters. That is, for Windows 2000 and later, NDIS defines the NDIS_STRING type as a UNICODE_STRING type.

SubKeyHandle [out]

Pointer to a caller-supplied variable in which this function returns a handle to the opened subkey if this call is successful.

Return value

None

Remarks

NdisOpenConfigurationKeyByName allows a driver to access configuration information that is stored in a named subkey in the registry.

Note that the ConfigurationHandle passed in to NdisOpenConfigurationKeyByName can be any valid handle to a registry key already opened by the caller. NdisOpenConfigurationKeyByName returns configuration information for subkeys relative to any valid ConfigurationHandle.

After a driver has consumed and, possibly, modified the registry configuration information, it must call NdisCloseConfiguration to release the handle obtained from NdisOpenConfigurationKeyByName. NdisCloseConfiguration also frees any temporary storage NDIS allocated in the driver's calls to NdisReadConfiguration, NdisReadNetworkAddress, and/or NdisWriteConfiguration with the SubKeyHandle returned by NdisOpenConfigurationKeyByName.

Requirements

Target platform

Universal

Version

See NdisOpenConfigurationKeyByName.

Header

Ndis.h (include Ndis.h)

Library

Ndis.lib

IRQL

< DISPATCH_LEVEL

See also

ANSI_STRING
MiniportInitialize
NdisCloseConfiguration
NdisOpenConfiguration
NdisOpenConfigurationKeyByIndex
NdisOpenProtocolConfiguration
NdisReadConfiguration
NdisWriteConfiguration
ProtocolBindAdapter
UNICODE_STRING

 

 

Send comments about this topic to Microsoft

Show: