Share via


NdisOpenConfigurationKeyByName (Windows CE 5.0)

Send Feedback

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

VOID NdisOpenConfigurationKeyByName(PNDIS_STATUSStatus,NDIS_HANDLEConfigurationHandle,PNDIS_STRINGSubKeyName,PNDIS_HANDLESubKeyHandle);

Parameters

  • Status
    [out] Points to a caller-supplied variable in which this function returns the status of its attempt to open the registry key.
  • ConfigurationHandle
    [in] The handle to a registry key for which a sub key should be opened. Usually, ConfigurationHandle was returned by NdisOpenConfiguration, or NdisOpenProtocolConfiguration.
  • 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 Values

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

OS Versions: Windows CE .NET 4.0 and later.
Header: Ndis.h.

See Also

NdisCloseConfiguration | NdisOpenConfiguration | NdisOpenProtocolConfiguration | NdisReadConfiguration | NdisReadNetworkAddress | NdisWriteConfiguration | NdisOpenConfigurationKeyByIndex

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.