SetupSetSourceListW function (setupapi.h)

Article
02/09/2023

[This function is available for use in the operating systems indicated in the Requirements section. It may be altered or unavailable in subsequent versions. SetupAPI should no longer be used for installing applications. Instead, use the Windows Installer for developing application installers. SetupAPI continues to be used for installing device drivers.]

The SetupSetSourceList function allows the caller to set the list of installation sources for either the current user or the system (common to all users).

Syntax

WINSETUPAPI BOOL SetupSetSourceListW(
  [in] DWORD  Flags,
  [in] PCWSTR *SourceList,
  [in] UINT   SourceCount
);

Parameters

[in] Flags

Specifies the type of list. This parameter can be a combination of the following values.

SRCLIST_SYSTEM

The list is the per-system Most Recently Used (MRU) list stored in the registry. The caller must be a member of the administrators local group.

SRCLIST_USER

The list is the per-user MRU list stored in the registry.

SRCLIST_TEMPORARY

The specified list is temporary and will be the only list accessible to the current process until SetupCancelTemporarySourceList is called or SetSourceList is called again.

Important If a temporary list is set, sources are not added to or deleted from the system or user lists, even if subsequent calls to SetupAddToSourceList or SetupRemoveFromSourceList explicitly specify those lists.

Note One of the SRCLIST_SYSTEM, SRCLIST_USER, or SRCLIST_TEMPORARY flags must be specified.

SRCLIST_NOBROWSE

The user is not allowed to add or change sources when SetupPromptForDisk is used. This flag is typically used in combination with the SRCLIST_TEMPORARY flag.

[in] SourceList

Pointer to an array of strings to use as the source list, as specified by the Flags parameter.

[in] SourceCount

Number of elements in the array pointed to by SourceList.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Note

The setupapi.h header defines SetupSetSourceList as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	setupapi.h
Library	Setupapi.lib
DLL	Setupapi.dll