Hardware Dev Center

WcsGetDefaultColorProfile function

The WcsGetDefaultColorProfile function retrieves the default color profile for a device, or the device-independent default if the device is not specified.

Syntax


BOOL WcsGetDefaultColorProfile(
  _In_     WCS_PROFILE_MANAGEMENT_SCOPE profileManagementScope,
  _In_opt_ PCWSTR                       pDeviceName,
  _In_     COLORPROFILETYPE             cptColorProfileType,
  _In_     COLORPROFILESUBTYPE          cpstColorProfileSubType,
  _In_     DWORD                        dwProfileID,
  _In_     DWORD                        cbProfileName,
  _Out_    LPWSTR                       pProfileName
);

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

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.

cbProfileName [in]

The buffer size, in bytes, of the buffer pointed to by pProfileName.

pProfileName [out]

A pointer to a buffer to receive the name of the color profile.

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 the WcsGetDefaultColorProfileSize function to obtain the required size of the buffer pointed to by the pProfileName parameter.

If WCS_PROFILE_MANAGEMENT_SCOPE_CURRENT_USER, the current user setting, is present, it overrides the system-wide default for profileManagementScope.

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
WcsGetDefaultColorProfileSize

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft