Skip to content

Latest commit

 

History

History
164 lines (99 loc) · 5.92 KB

nf-setupapi-setupsetsourcelistw.md

File metadata and controls

164 lines (99 loc) · 5.92 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:setupapi.SetupSetSourceListW
SetupSetSourceListW function (setupapi.h)
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). (Unicode)
SetupSetSourceList
SetupSetSourceList function [Setup API]
SetupSetSourceListW
_setupapi_setupsetsourcelist
setup.setupsetsourcelist
setupapi/SetupSetSourceList
setupapi/SetupSetSourceListW
setup\setupsetsourcelist.htm
setup
6a37a56c-ae44-4a57-9307-90efcf025d1a
12/05/2018
SetupSetSourceList, SetupSetSourceList function [Setup API], SetupSetSourceListA, SetupSetSourceListW, _setupapi_setupsetsourcelist, setup.setupsetsourcelist, setupapi/SetupSetSourceList, setupapi/SetupSetSourceListA, setupapi/SetupSetSourceListW
setupapi.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
SetupSetSourceListW (Unicode) and SetupSetSourceListA (ANSI)
Setupapi.lib
Setupapi.dll
Windows
19H1
SetupSetSourceListW
setupapi/SetupSetSourceListW
c++
APIRef
kbSyntax
DllExport
Setupapi.dll
SetupSetSourceList
SetupSetSourceListA
SetupSetSourceListW

SetupSetSourceListW function

-description

[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).

-parameters

-param Flags [in]

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.

-param SourceList [in]

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

-param SourceCount [in]

Number of elements in the array pointed to by SourceList.

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

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

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

- Flags.SRCLIST_USER

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

-returns

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.

-see-also

Functions

Overview

SetupAddToSourceList

SetupCancelTemporarySourceList

SetupRemoveFromSourceList

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