FILEPATHS_A structure (setupapi.h)

The FILEPATHS structure stores source and target path information. The setup functions send the FILEPATHS structure as a parameter in several of the notifications sent to callback routines. For more information, see Notifications.

Syntax

typedef struct _FILEPATHS_A {
  PCSTR Target;
  PCSTR Source;
  UINT  Win32Error;
  DWORD Flags;
} FILEPATHS_A, *PFILEPATHS_A;

Members

Target

Path to the target file.

Source

Path to the source file. This member is not used when the FILEPATHS structure is used with a file delete operation.

Win32Error

If an error occurs, this member is the system error code. If no error has occurred, it is NO_ERROR.

Flags

Additional information that depends on the notification sent with the FILEPATHS structure.

For SPFILENOTIFY_COPYERROR notifications, Flags specifies dialog box behavior and can be one of the following values.

Value Meaning
SP_COPY_NOBROWSE
Do not offer the user the option to browse.
SP_COPY_NOSKIP
Do not offer the user the option to skip the file.
SP_COPY_WARNIFSKIP
Inform the user that skipping the file may affect the installation.
 

For SPFILENOTIFY_FILEOPDELAYED notifications, Flags specifies the type of file operation delayed and can be one of the following values.

Value Meaning
FILEOP_COPY
A file copy operation was delayed.
FILEOP_DELETE
A file delete operation was delayed.

Remarks

Note

The setupapi.h header defines FILEPATHS as an alias that 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 is 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

See also

Overview

Structures