NdisWriteConfiguration

This function writes a caller-supplied value for a specified entry into the registry.

At a Glance

Header file:	Ndis.h
Windows CE versions:	2.0 and later

Syntax

VOID NdisWriteConfiguration( OUT PNDIS_STATUS Status,
IN NDIS_HANDLE WrapperConfigurationContext,
IN PNDIS_STRING Keyword,
IN PNDIS_CONFIGURATION_PARAMETER *ParameterValue );

Parameters

Status

Pointer to a caller-supplied variable in which this function returns the status of the call as one of the following:

NDIS_STATUS_SUCCESS: The supplied value at ParameterValue was written into the registry. If this is a new entry, the name at Keyword was also written into the registry.
NDIS_STATUS_NOT_SUPPORTED: The supplied ParameterType is invalid.
NDIS_STATUS_RESOURCES: NDIS could not allocate resources, usually enough memory, to transfer the requested information to the registry.
NDIS_STATUS_FAILURE: The requested information could not be written.

WrapperConfigurationContext

Specifies the handle returned by the NdisOpenConfiguration or the NdisOpenProtocolConfiguration function.

Keyword

Pointer to a caller-supplied counted string, in the system-default character set, specifying the name of an entry for which to write the value.

ParameterValue

Points to a caller-supplied variable set to the address of a filled-in NDIS_CONFIGURATION_PARAMETER structure.

Remarks

If an entry of the same name as at Keyword already exists under the opened registry key, this function replaces its current value with the caller-supplied value. Otherwise, this function adds a new value entry with the specified name and supplied value to the registry.

This function buffers and copies the caller-supplied string at Keyword and the caller-supplied data specified at ParameterValue. This memory is freed when the driver releases the ConfigurationHandle with the NdisCloseConfiguration function. The caller of this function is responsible for releasing the buffered string at Keyword and the memory allocated for the NDIS_CONFIGURATION_PARAMETER structure.

As an alternative to calling this function, every NDIS driver can set up configuration information in the registry for itself under the driver’s Parameters key, using an installation script.

A driver that calls this function runs at IRQL PASSIVE_LEVEL.