EnumDisplaySettingsEx

The EnumDisplaySettingsEx function retrieves information about one of the graphics modes for a display device. To retrieve information for all the graphics modes for a display device, make a series of calls to this function.

This function differs from EnumDisplaySettings in that there is a dwFlags parameter.

BOOL EnumDisplaySettingsEx(

__in LPCTSTR lpszDeviceName,

__in DWORD iModeNum,

__out LPDEVMODE lpDevMode,

__in DWORD dwFlags

);

FUNCTION EnumDisplaySettingsEx ( _

BYREF lpszDeviceName AS ASCIIZ, _

BYVAL iModeNum AS DWORD, _

BYREF lpDevMode AS DEVMODE, _

BYVAL dwFlags AS DWORD _

) AS LONG

FUNCTION EnumDisplaySettingsExW ( _

BYVAL lpszDeviceName AS DWORD, _

BYVAL iModeNum AS DWORD, _

BYREF lpDevMode AS DEVMODEW, _

BYVAL dwFlags AS DWORD _

) AS LONG

[in] Pointer to a null-terminated string that specifies the display device about whose graphics mode the function will obtain information.

This parameter is either NULL or a DISPLAY_DEVICE.DeviceName returned from EnumDisplayDevices. A NULL value specifies the current display device on the computer on which the calling thread is running.

[in] Specifies the type of information to retrieve. This value can be a graphics mode index or one of the following values.

Value	Meaning
ENUM_CURRENT_SETTINGS	Retrieve the current settings for the display device.
ENUM_REGISTRY_SETTINGS	Retrieve the settings for the display device that are currently stored in the registry.

Graphics mode indexes start at zero. To obtain information for all of a display device's graphics modes, make a series of calls to EnumDisplaySettingsEx, as follows: Set iModeNum to zero for the first call, and increment iModeNum by one for each subsequent call. Continue calling the function until the return value is zero.

When you call EnumDisplaySettingsEx with iModeNum set to zero, the operating system initializes and caches information about the display device. When you call EnumDisplaySettingsEx with iModeNum set to a non-zero value, the function returns the information that was cached the last time the function was called with iModeNum set to zero.

[out] Pointer to a DEVMODE structure into which the function stores information about the specified graphics mode. Before calling EnumDisplaySettingsEx, set the dmSize member to SIZEOF(DEVMODE), and set the dmDriverExtra member to indicate the size, in bytes, of the additional space available to receive private driver data.

The EnumDisplaySettingsEx function will populate the dmFields member of the lpDevMode and one or more other members of the DEVMODE structure. To determine which members were set by the call to EnumDisplaySettingsEx, inspect the dmFields bitmask. Some of the fields typically populated by this function include:

Value	Meaning
EDS_RAWMODE	If set, the function will return all graphics modes reported by the adapter driver, regardless of monitor capabilities. Otherwise, it will only return modes that are compatible with current monitors.

The function fails if iModeNum is greater than the index of the display device's last graphics mode. As noted in the description of the iModeNum parameter, you can use this behavior to enumerate all of a display device's graphics modes.

Windows 95/98/Me: EnumDisplaySettingsW is supported by the Microsoft Layer for Unicode.