WcsGetDefaultColorProfile

  • Article

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

BOOL WINAPI WcsGetDefaultColorProfile(
  __in WCS_PROFILE_MANAGEMENT_SCOPEprofileManagementScope,
  __in_opt PCWSTRpDeviceName,
  __in COLORPROFILETYPEcptColorProfileType,
  __in COLORPROFILESUBTYPEcpstColorProfileSubType,
  __in DWORDdwProfileID,
  __in DWORDcbProfileName,
  __out_bcount(cbProfileName) LPWSTRpProfileName);

Parameters

  • profileManagementScope
    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.

Return Values

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

**  Windows Vista:** Included in Windows Vista and later.
**  Header:** Declared in Icm.h.
**  Library:** Use Mscms.lib.
**  Unicode:** Implemented as Unicode and ANSI versions on Windows Vista.

See Also

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