Share via

WcsGetDefaultColorProfileSize

  • Article

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

BOOL WINAPI WcsGetDefaultColorProfileSize(
   __in WCS_PROFILE_MANAGEMENT_SCOPEprofileManagementScope,
   __in_opt PCWSTRpDeviceName,
   __in COLORPROFILETYPEcptColorProfileType,
   __in COLORPROFILESUBTYPEcpstColorProfileSubType,
   __in DWORDdwProfileID,
   __out PDWORDpcbProfileName);

Parameters

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

**  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, WcsGetDefaultColorProfile