WcsGetDefaultColorProfileSize function

The WcsGetDefaultColorProfileSize function returns the size, in bytes, of the default color profile name for a device, including the NULL terminator.

Syntax


BOOL WcsGetDefaultColorProfileSize(
  _In_      WCS_PROFILE_MANAGEMENT_SCOPE profileManagementScope,
  _In_opt_  PCWSTR                       pDeviceName,
  _In_      COLORPROFILETYPE             cptColorProfileType,
  _In_      COLORPROFILESUBTYPE          cpstColorProfileSubType,
  _In_      DWORD                        dwProfileID,
  _Out_     PDWORD                       pcbProfileName
);

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 obtained. 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.

pcbProfileName [out]

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

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

Use this function to return the required size of the buffer pointed to by the pProfileName parameter in the WcsGetDefaultColorProfile function.

This function is executable in Least-Privileged User Account (LUA) context.

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
WcsGetDefaultColorProfile

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft