Edit

Share via

WcsGetDefaultColorProfile function (icm.h)

  • Article

Retrieves the default color profile for a device, or for a device-independent default if the device is not specified.

Note

This API does not support "advanced color" profiles for HDR monitors. Use ColorProfileGetDisplayDefault for managing advanced color profiles.

Syntax

BOOL WcsGetDefaultColorProfile(
  WCS_PROFILE_MANAGEMENT_SCOPE scope,
  PCWSTR                       pDeviceName,
  COLORPROFILETYPE             cptColorProfileType,
  COLORPROFILESUBTYPE          cpstColorProfileSubType,
  DWORD                        dwProfileID,
  DWORD                        cbProfileName,
  LPWSTR                       pProfileName
);

Parameters

scope

A WCS_PROFILE_MANAGEMENT_SCOPE value specifying the scope of this profile management operation.

pDeviceName

A pointer to the name of the device for which the default color profile is obtained. If NULL, a device-independent default profile is obtained.

cptColorProfileType

A COLORPROFILETYPE value specifying the color profile type.

cpstColorProfileSubType

A COLORPROFILESUBTYPE value specifying the color profile subtype.

dwProfileID

The ID of the color space that the color profile represents.

cbProfileName

The buffer size, in bytes, of the buffer that is pointed to by pProfileName.

pProfileName

A pointer to a buffer to receive the name of the color profile. The size of the buffer, in bytes, will be the indicated by cbProfileName.

Return value

If this function succeeds, the return value is TRUE.

If this function fails, the return value is FALSE. For extended error information, call GetLastError.

Remarks

Use the WcsGetDefaultColorProfileSize function to obtain the required size of the buffer that is pointed to by the pProfileName parameter.

If WCS_PROFILE_MANAGEMENT_SCOPE_CURRENT_USER is present, it overrides the system-wide default for profileManagementScope.

This function is executable in Least-Privileged User Account (LUA) context.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header icm.h
Library Mscms.lib
DLL Mscms.dll

See also