WcsSetDefaultColorProfile function

The WcsSetDefaultColorProfile function sets the default color profile name of the specified profile type in the specified profile management scope.

Syntax


BOOL WcsSetDefaultColorProfile(
  _In_     WCS_PROFILE_MANAGEMENT_SCOPE profileManagementScope,
  _In_opt_ PCWSTR                       pDeviceName,
  _In_     COLORPROFILETYPE             cptColorProfileType,
  _In_     COLORPROFILESUBTYPE          cpstColorProfileSubType,
  _In_     DWORD                        dwProfileID,
  _In_opt_ 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 will be 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.

pProfileName [in, optional]

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

If this function succeeds, the return value is TRUE.

If this function fails, the return value is FALSE. For extended error information, call GetLastError (described in the Microsoft Windows SDK documentation).

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.

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

Requirements

Target platform

Universal

Version

Included in Windows Vista and later.

Header

Icm.h

Library

Mscms.lib

DLL

Mscms.dll

See also

COLORPROFILESUBTYPE
COLORPROFILETYPE
WCS_PROFILE_MANAGEMENT_SCOPE
WcsGetDefaultColorProfileSize

 

 

Send comments about this topic to Microsoft

Show: