SetupSetSourceList

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

BOOL SetupSetSourceList(
  DWORD Flags,         // type of source list
  PCTSTR *SourceList,  // array of sources listed
  UINT SourceCount     // number of sources in the array
);
 

Parameters

Flags

These flags specify 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 will not be 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.

SourceList

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

SourceCount

Specifies the number of elements in the array pointed to by SourceList.

Return Values

If the function succeeds, the return value is a non-zero value.

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

QuickInfo

  Windows NT: Use version 4.0 and later.
  Windows: Use Windows 95 and later.
  Windows CE: Unsupported.
  Header: Declared in setupapi.h.
  Import Library: Link with setupapi.lib.

See Also

Overview, Functions, SetupAddToSourceList, SetupCancelTemporarySourceList, SetupRemoveFromSourceList