Edit

Share via

WcsGetDefaultColorProfileSize function (icm.h)

  • Article

Returns the size, in bytes, of the default color profile name (including the NULL terminator), for a device.

Note

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

Syntax

BOOL WcsGetDefaultColorProfileSize(
  WCS_PROFILE_MANAGEMENT_SCOPE scope,
  PCWSTR                       pDeviceName,
  COLORPROFILETYPE             cptColorProfileType,
  COLORPROFILESUBTYPE          cpstColorProfileSubType,
  DWORD                        dwProfileID,
  PDWORD                       pcbProfileName
);

Parameters

scope

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

pDeviceName

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

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.

pcbProfileName

A pointer to a location that receives the size, in bytes, of the path name of the default color profile, including the NULL terminator.

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 this function to return the required size of the buffer that is pointed to by the pProfileName parameter in the WcsGetDefaultColorProfile function.

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