Skip to content

Latest commit

 

History

History
92 lines (68 loc) · 3.69 KB

nf-icm-wcsenumcolorprofiles.md

File metadata and controls

92 lines (68 loc) · 3.69 KB
UID title description tech.root ms.date targetos req.assembly req.construct-type req.ddi-compliance req.dll req.header req.idl req.include-header req.irql req.kmdf-ver req.lib req.max-support req.namespace req.redist req.target-min-winverclnt req.target-min-winversvr req.target-type req.type-library req.umdf-ver req.unicode-ansi topic_type api_type api_location api_name f1_keywords dev_langs
NF:icm.WcsEnumColorProfiles
WcsEnumColorProfiles
Enumerates all color profiles that satisfy the enumeration criteria in the specified profile management scope.
wcs
02/01/2021
Windows
function
Mscms.dll
icm.h
Mscms.lib
Windows 2000 Professional \[desktop apps only\]
Windows 2000 Server \[desktop apps only\]
apiref
mscms.dll
WcsEnumColorProfiles
WcsEnumColorProfiles
icm/WcsEnumColorProfiles
c++

-description

Enumerates color profiles associated with any device, in the specified scope.

Note

This API does not support "advanced color" profiles for HDR monitors. Use ColorProfileGetDisplayList for managing advanced color profiles.

-parameters

-param scope

A WCS_PROFILE_MANAGEMENT_SCOPE value specifying the scope of this profile management operation.

-param pEnumRecord

A pointer to a structure specifying the enumeration criteria.

-param pBuffer

A pointer to a buffer in which the profile names are to be enumerated. The WcsEnumColorProfiles function places, in this buffer, a MULTI_SZ string that consists of profile names that satisfy the criteria specified in *pEnumRecord.

-param dwSize

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

-param pnProfiles

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

-returns

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 WcsEnumColorProfilesSize function to retrieve 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 WcsSetUsePerUserProfiles has never been called for this user, or if 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.

-see-also