Edit

Share via

SetStandardColorSpaceProfileW function (icm.h)

  • Article

Registers a specified profile for a given standard color space. The profile can be queried using GetStandardColorSpaceProfileW.

Syntax

BOOL SetStandardColorSpaceProfileW(
  PCWSTR pMachineName,
  DWORD  dwProfileID,
  PCWSTR pProfileName
);

Parameters

pMachineName

Reserved. Must be NULL. This parameter is intended to point to the name of the machine on which to set a standard color space profile. A NULL pointer indicates the local machine.

dwProfileID

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

pProfileName

Points to a fully qualified path to the profile file.

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

The profile must already be installed on the system before it can be registered for a standard color space.

This function supports Windows Color System (WCS) device model profiles (DMPs) in addition to International Color Consortium (ICC) profiles. It does not support WCS CAMP or GMMP profiles and will return an error if such profiles are used.

Per-user/LUA support

This will register a specified profile for a given standard color space only for current user.

This uses WcsSetDefaultColorProfile with WCS_PROFILE_MANAGEMENT_SCOPE_CURRENT_USER.

This is executable in LUA context if the profile is already installed, fails otherwise with access denied since install is system-wide and requires administrator privileges.

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