VideoPortGetRegistryParameters function

The VideoPortGetRegistryParameters function retrieves device-specific configuration information under the adapter key in the registry at startup.

Syntax

VIDEOPORT_API VP_STATUS VideoPortGetRegistryParameters(
  PVOID                          HwDeviceExtension,
  PWSTR                          ParameterName,
  UCHAR                          IsParameterFileName,
  PMINIPORT_GET_REGISTRY_ROUTINE GetRegistryRoutine,
  PVOID                          Context
);

Parameters

HwDeviceExtension

Pointer to the miniport driver's device extension.

ParameterName

Pointer to a NULL-terminated Unicode string that names the value entry to be retrieved from the registry. See the Remarks section for more information.

IsParameterFileName

If the value is TRUE, the data value normally returned is treated as a file name. In that case, the buffered contents of that file are returned, rather than the parameter itself.

GetRegistryRoutine

Pointer to the miniport driver's HwVidQueryNamedValueCallback function.

Context

Pointer to a caller-determined context parameter to be passed to the CallbackRoutine, typically the VIDEO_PORT_CONFIG_INFO buffer.

Return Value

VideoPortGetRegistryParameters returns NO_ERROR if it successfully collected the requested information and called the miniport driver's HwVidQueryNamedValueCallback function; otherwise returns ERROR_INVALID_PARAMETER.

Remarks

VideoPortGetRegistryParameters cannot be called from a miniport driver's HwVidInterrupt or HwVidTimer functions, or from VideoPortQueueDpc, or from a callback to VideoPortSynchronizeExecution.

For Windows XP and later operating system versions, the ParameterName parameter can contain a path that exactly references a value name one or more levels below the adapter key. For example, the string "SubKey1\Value1" can be used to obtain the value entry for the Value1 value number under the SubKey1 subkey.

The registry key from which VideoPortGetRegistryParameters retrieves configuration information cannot contain any information about the corresponding display driver, because miniport driver HwVidFindAdapter functions execute before any display driver is loaded.

Miniport drivers should not query configuration information stored in the DefaultSettings entries, which may not be supported in later versions of the operating system.

Requirements

   
Minimum supported client Available in Windows 2000 and later versions of the Windows operating systems.
Target Platform Desktop
Header video.h (include Video.h)
Library Videoprt.lib
DLL Videoprt.sys
IRQL PASSIVE_LEVEL

See Also

HwVidFindAdapter

HwVidInitialize

HwVidQueryDeviceCallback

HwVidQueryNamedValueCallback

VIDEO_PORT_CONFIG_INFO

VideoPortFlushRegistry

VideoPortGetDeviceData

VideoPortSetRegistryParameters