WcmSetProfileList function

The WcmSetProfileList function reorders a profile list or a subset of a profile list.

Syntax

DWORD WcmSetProfileList(
  WCM_PROFILE_INFO_LIST *pProfileList,
  DWORD                 dwPosition,
  BOOL                  fIgnoreUnknownProfiles,
  PVOID                 pReserved
);

Parameters

pProfileList

Type: WCM_PROFILE_INFO_LIST*

The list of profiles to be reordered, provided in the preferred order (descending from the most preferred to the least preferred).

dwPosition

Type: DWORD

Specifies the position in the list to start the reorder.

fIgnoreUnknownProfiles

Type: BOOL

True if any profiles in pProfileList which do not exist should be ignored; the call will proceed with the remainder of the list. False if the call should fail without modifying the profile order if any profiles in pProfileList do not exist.

pReserved

Type: PVOID

Reserved.

Return Value

Type: DWORD

Returns ERROR_SUCCESS if successful, or an error value otherwise.

Requirements

   
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header wcmapi.h
Library Wcmapi.lib
DLL Wcmapi.dll

See Also

WCM_PROFILE_INFO_LIST