WcsSetDefaultColorProfile function

Sets the default color profile name for the specified profile type in the specified profile management scope.

Syntax


BOOL WINAPI WcsSetDefaultColorProfile(
  _In_     WCS_PROFILE_MANAGEMENT_SCOPE profileManagementScope,
  _In_opt_ PCWSTR                       pDeviceName,
  _In_     COLORPROFILETYPE             cptColorProfileType,
  _In_     COLORPROFILESUBTYPE          cpstColorProfileSubType,
  _In_     DWORD                        dwProfileID,
  _In_     LPCWSTR                      pProfileName
);

Parameters

profileManagementScope [in]

A WCS_PROFILE_MANAGEMENT_SCOPE value that specifies the scope of this profile management operation.

pDeviceName [in, optional]

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

cptColorProfileType [in]

A COLORPROFILETYPE value that specifies the color profile type.

cpstColorProfileSubType [in]

A COLORPROFILESUBTYPE value that specifies the color profile subtype.

dwProfileID [in]

The ID of the color space that the color profile represents. This is a custom ID value used to uniquely identify the color space profile within your application.

pProfileName [in]

A pointer to a buffer that holds the name of the color profile. See Remarks.

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

If the pProfileName parameter is NULL and the profileManagementScope parameter is WCS_PROFILE_MANAGEMENT_SCOPE_CURRENT_USER, subsequent calls to WcsSetDefaultColorProfile will return the system-wide default profile.

If profileManagementScope is WCS_PROFILE_MANAGEMENT_SCOPE_CURRENT_USER, this function is executable in Least-Privileged User Account (LUA) context. Otherwise, administrative privileges are required. The specified profile must already be installed, but it may be not yet associated with the specified device in the specified profile management scope.

When WcsSetDefaultColorProfile is called to set a device model profile DMP as the default profile for the RGB or custom working space, only a DMP profile that is of type RGBVirtualDevice, LCD, or CRT is valid; all others are invalid.

When WcsSetDefaultColorProfile is called to set an International Color Consortium (ICC) profile as the default profile for the RGB or custom working space, only an ICC profile with class "spac" or "disp", and "RGB" color space is valid; all others are invalid.

See notes on valid profile type/subtype combinations.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Icm.h

Library

Mscms.lib

DLL

Mscms.dll

See also

Basic Color Management Concepts
Windows Color System Schemas and Algorithms
Functions
COLORPROFILESUBTYPE
COLORPROFILETYPE
WCS_PROFILE_MANAGEMENT_SCOPE
WcsGetDefaultColorProfileSize

 

 

Show: