Share via

NdisOpenConfigurationKeyByName (Windows Embedded CE 6.0)

  • Article

1/6/2010

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

Syntax

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

Parameters

  • Status
    [out] Points to a caller-supplied variable in which this function returns the status of its attempt to open the registry key.
  • SubKeyName
    [in] Points to a caller-supplied, counted string in the system-default character set that specifies the name of the registry sub key to open.
  • SubKeyHandle
    [out] Points to a caller-supplied variable in which this function returns a handle to the opened sub key if this call is successful.

Return Value

The following table shows return values for this function.

Value Description

NDIS_STATUS_SUCCESS

NDIS has initialized accessed to the sub key specified by KeyName and Index.

NDIS_STATUS_FAILURE

The key could not be opened.

Remarks

NdisOpenConfigurationKeyByName allows a driver to access configuration information that is stored in a named sub key 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 sub keys 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

Header ndis.h
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

NDIS Library Functions
NdisCloseConfiguration
NdisOpenConfiguration
NdisOpenProtocolConfiguration
NdisReadConfiguration
NdisReadNetworkAddress
NdisWriteConfiguration
NdisOpenConfigurationKeyByIndex