WcsEnumColorProfiles function

The WcsEnumColorProfiles function enumerates all color profiles that satisfy the enumeration criteria in the specified profile management scope.

Syntax

BOOL WcsEnumColorProfiles(
  WCS_PROFILE_MANAGEMENT_SCOPE scope,
  PENUMTYPEW                   pEnumRecord,
  PBYTE                        pBuffer,
  DWORD                        dwSize,
  PDWORD                       pnProfiles
);

Parameters

scope

TBD

pEnumRecord

A pointer to a structure that specifies the enumeration criteria.

pBuffer

A pointer to a buffer in which the profile names are to be enumerated. A MULTI_SZ string that consists of profile names that satisfy the criteria specified in *pEnumRecord will be placed in this buffer.

dwSize

A variable that contains the size, in bytes, of the buffer pointed to by pBuffer. See Remarks.

pnProfiles

An optional pointer to a variable that receives the number of profile names actually copied to the buffer pointed to by pBuffer. Can be NULL if this information is not needed.

Return Value

None

Remarks

Use the WcsEnumColorProfilesSize function to obtain the value for the dwSize parameter, which is the size, in bytes, of the buffer pointed to by the pBuffer parameter.

If the profileManagementScope parameter is WCS_PROFILE_MANAGEMENT_SCOPE_SYSTEM_WIDE, only system-wide associations of profiles to the device are considered. If profileManagementScope is WCS_PROFILE_MANAGEMENT_SCOPE_CURRENT_USER, only per-user associations for the current user are considered. If either WcsSetUsePerUserProfiles has never been called for this user, or WcsSetUsePerUserProfiles was most recently called for this user with its usePerUserProfiles parameter set to FALSE, then WCSEnumColorProfiles returns an empty list.

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

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

Requirements

   
Windows version Included in Windows Vista and later.
Target Platform Universal
Header icm.h
Library Mscms.lib
DLL Mscms.dll

See Also

WCS_PROFILE_MANAGEMENT_SCOPE

WcsEnumColorProfilesSize