SetupBackupErrorA function (setupapi.h)
[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 SetupBackupError function generates a dialog box that informs the user of a backup error.
Syntax
WINSETUPAPI UINT SetupBackupErrorA(
[in] HWND hwndParent,
[in] PCSTR DialogTitle,
[in] PCSTR SourceFile,
[in] PCSTR TargetFile,
[out] UINT Win32ErrorCode,
[in] DWORD Style
);
Parameters
[in] hwndParent
Handle to the parent window for this dialog box.
[in] DialogTitle
Optional pointer to a null-terminated string specifying the error dialog box title. If this parameter is NULL, the default title of "Backup Error" (localized) is used.
[in] SourceFile
Pointer to a null-terminated string specifying the full path of the source file that is being backed up.
[in] TargetFile
Optional pointer to a null-terminated string specifying the full path of the backup name of the file. This parameter can be NULL.
[out] Win32ErrorCode
If an error occurs, this member is the system error code. If no error has occurred, it is NO_ERROR.
[in] Style
Flags that control display formatting and behavior of the dialog box. This parameter can be one of the following flags.
IDF_NOBEEP
Prevent the dialog box from beeping to get the user's attention when it first appears.
IDF_NOFOREGROUND
Prevent the dialog box from becoming the foreground window.
Return value
This function returns one of the following values.
To get extended error information, call GetLastError.
Remarks
Note
The setupapi.h header defines SetupBackupError 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 |