Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

WcsGetDefaultColorProfile function

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

Syntax


BOOL WINAPI 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 specifying 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 obtained. If NULL, a device-independent default profile is obtained.

cptColorProfileType [in]

A COLORPROFILETYPE value specifying the color profile type.

cpstColorProfileSubType [in]

A COLORPROFILESUBTYPE value specifying 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 that is pointed to by pProfileName.

pProfileName [out]

A pointer to a buffer to receive the name of the color profile. The size of the buffer, in bytes, will be the indicated by cbProfileName.

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Icm.h

Library

Mscms.lib

DLL

Mscms.dll

See also

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

 

 

Show: