SOURCE_MEDIA_A structure (setupapi.h)

Article
02/22/2024

The SOURCE_MEDIA structure is used with the SPFILENOTIFY_NEEDMEDIA notification to pass source media information.

Syntax

typedef struct _SOURCE_MEDIA_A {
  PCSTR Reserved;
  PCSTR Tagfile;
  PCSTR Description;
  PCSTR SourcePath;
  PCSTR SourceFile;
  DWORD Flags;
} SOURCE_MEDIA_A, *PSOURCE_MEDIA_A;

Members

Reserved

This member is not currently used.

Tagfile

Optional tag file that can be used to identify the source media.

Description

Human-readable description of the source media.

SourcePath

Path to the source that needs the new media.

SourceFile

Source file to be retrieved from the new media.

Flags

Copy style information that modifies how errors are handled. This member can be one or more of the following values.

SP_COPY_WARNIFSKIP

Inform the user that skipping the file may affect the installation.

SP_COPY_NOSKIP

Do not offer the user the option to skip the file.

SP_FLAG_CABINETCONTINUATION

The current source file is continued in another cabinet file.

SP_COPY_NOBROWSE

Do not offer the user the option to browse.

Remarks

Note

The setupapi.h header defines SOURCE_MEDIA 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]
Header	setupapi.h