Skip to content

Latest commit

 

History

History
131 lines (82 loc) · 4.05 KB

nf-setupapi-setuprenameerrora.md

File metadata and controls

131 lines (82 loc) · 4.05 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.SetupRenameErrorA
SetupRenameErrorA function (setupapi.h)
The RenameError function generates a dialog box that informs the user of a file renaming error. (ANSI)
SetupRenameErrorA
setupapi/SetupRenameErrorA
setup\setuprenameerror.htm
setup
43371fa0-d7b4-42e0-a94d-d307a7210618
12/05/2018
SetupRenameError, SetupRenameError function [Setup API], SetupRenameErrorA, SetupRenameErrorW, _setupapi_setuprenameerror, setup.setuprenameerror, setupapi/SetupRenameError, setupapi/SetupRenameErrorA, setupapi/SetupRenameErrorW
setupapi.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
SetupRenameErrorW (Unicode) and SetupRenameErrorA (ANSI)
Setupapi.lib
Setupapi.dll
Windows
19H1
SetupRenameErrorA
setupapi/SetupRenameErrorA
c++
APIRef
kbSyntax
DllExport
Setupapi.dll
SetupRenameError
SetupRenameErrorA
SetupRenameErrorW

SetupRenameErrorA 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 RenameError function generates a dialog box that informs the user of a file renaming error.

-parameters

-param hwndParent [in]

Handle to the parent window for this dialog box.

-param DialogTitle [in]

Pointer to a null-terminated string that specifies the error dialog box title. This parameter may be NULL. If this parameter is NULL, the default title of "Rename Error" (localized) is used.

-param SourceFile [in]

Pointer to a null-terminated string that specifies the full path of the source file on which the operation failed.

-param TargetFile [in]

Pointer to a null-terminated string that specifies the full path of the target file on which the operation failed.

-param Win32ErrorCode [in]

The system error code encountered during the file operation.

-param Style [in]

Specifies 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 when it first appears.

IDF_NOFOREGROUND

Prevent the dialog box from becoming the foreground window.

-returns

This function returns one of the following values.

To get extended error information, call GetLastError.

-see-also

Functions

Overview

SetupCopyError

SetupDeleteError

SetupPromptForDisk

-remarks

Note

The setupapi.h header defines SetupRenameError 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.