SetupCopyErrorA-Funktion (setupapi.h)
[Diese Funktion steht für die Verwendung in den im Abschnitt "Anforderungen" angegebenen Betriebssystemen zur Verfügung. Sie kann in nachfolgenden Versionen geändert oder nicht verfügbar sein. SetupAPI sollte nicht mehr für die Installation von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Anwendungsinstallationsprogrammen. SetupAPI wird weiterhin für die Installation von Gerätetreibern verwendet.]
Die SetupCopyError--Funktion generiert ein Dialogfeld, um einen Benutzer über einen Kopierdateifehler zu benachrichtigen.
Syntax
WINSETUPAPI UINT SetupCopyErrorA(
[in] HWND hwndParent,
[in] PCSTR DialogTitle,
[in] PCSTR DiskName,
[in] PCSTR PathToSource,
[in] PCSTR SourceFile,
[in] PCSTR TargetPathFile,
[out] UINT Win32ErrorCode,
[in] DWORD Style,
[in, out] PSTR PathBuffer,
[in] DWORD PathBufferSize,
[in, out] PDWORD PathRequiredSize
);
Parameter
[in] hwndParent
Das Handle für das übergeordnete Fenster für dieses Dialogfeld.
[in] DialogTitle
Ein optionaler Zeiger auf eine NULL--terminated-Zeichenfolge, die den Dialogfeldtitel angibt.
Dieser Parameter kann NULL-sein. Wenn dieser Parameter NULL-ist, wird der Standardtitel "Copy Error" (lokalisiert in der Systemsprache) verwendet.
[in] DiskName
Ein optionaler Zeiger auf eine NULL--terminated-Zeichenfolge, die den Namen des einzufügenden Datenträgers angibt.
Dieser Parameter kann NULL-sein. Wenn dieser Parameter NULL-ist, wird der Standardname "(Unknown)" (lokalisiert in die Systemsprache) verwendet.
[in] PathToSource
Ein Zeiger auf die Pfadkomponente der Quelldatei, bei der ein Vorgang fehlschlägt, z. B. F:\x86.
Verwenden Sie eine null--terminated-Zeichenfolge.
[in] SourceFile
Ein Zeiger auf eine NULL--terminated-Zeichenfolge, die den Dateinamenteil der Datei angibt, bei dem ein Vorgang fehlschlägt.
Verwenden Sie eine null--terminated-Zeichenfolge. Dieser Dateiname wird angezeigt, wenn der Benutzer auf die Schaltflächen Details oder Durchsuchen klickt. Die SetupCopyError--Funktion sucht nach der Datei, die die komprimierten Formularnamen verwendet. Daher können Sie cmd.exe übergeben und sich keine Sorgen machen, dass die Datei tatsächlich als cmd.ex_ auf den Quellmedien vorhanden ist.
[in] TargetPathFile
Ein optionaler Zeiger auf eine NULL--terminated-Zeichenfolge, die den vollständigen Pfad der Zieldatei für Umbenennungs- und Kopiervorgänge angibt.
Verwenden Sie eine null--terminated-Zeichenfolge. Dieser Parameter kann NULL-sein. Wenn TargetPathFile nicht angegeben ist, wird "(Unknown)" (lokalisiert in die Systemsprache) verwendet.
[out] Win32ErrorCode
Wenn ein Fehler auftritt, ist dieses Element der Systemfehlercode.
Wenn kein Fehler auftritt, wird er NO_ERROR.
[in] Style
Die Kennzeichen, die die Anzeigeformatierung und das Verhalten eines Dialogfelds steuern.
Dieser Parameter kann eine der folgenden Flags sein.
IDF_NOBROWSE
Die Suchoption wird nicht angezeigt.
IDF_NOSKIP
Die Option "Datei überspringen" wird nicht angezeigt.
IDF_NODETAILS
Die Option "Details" wird nicht angezeigt.
Wenn dieses Flag festgelegt ist, können die parameter TargetPathFile- und Win32ErrorCode- parameter weggelassen werden.
IDF_NOCOMPRESSED
Überprüfen Sie nicht auf komprimierte Versionen der Quelldatei.
IDF_OEMDISK
Die Betriebsquelle ist ein Datenträger, den ein Hardwarehersteller bereitstellt.
IDF_NOBEEP
Verhindert, dass das Dialogfeld beim ersten Anzeigen die Aufmerksamkeit des Benutzers erhält.
IDF_NOFOREGROUND
Verhindert, dass das Dialogfeld zum Vordergrundfenster wird.
IDF_WARNIFSKIP
Warnt den Benutzer, dass sich das Überspringen einer Datei auf die Installation auswirken kann.
[in, out] PathBuffer
Ein optionaler Zeiger auf eine Variable, in der diese Funktion den Pfad (nicht einschließlich des Dateinamens) des Speicherorts zurückgibt, den ein Benutzer im Dialogfeld angibt. Sie sollten eine mit Null beendete Zeichenfolge verwenden.
Die null-terminated string sollte die Größe des Zielpuffers nicht überschreiten. Um unzureichende Pufferfehler zu vermeiden, sollte PathBuffer- mindestens MAX_PATH sein. Weitere Informationen finden Sie im Abschnitt "Hinweise" dieses Themas.
[in] PathBufferSize
Die Größe des Puffers, auf den PathBuffer in Zeichen verweist.
Die Puffergröße sollte mindestens MAX_PATH Zeichen sein, einschließlich des null Endator.
[in, out] PathRequiredSize
Ein optionaler Zeiger auf eine Variable, in der diese Funktion die erforderliche Puffergröße in Zeichen zurückgibt, einschließlich der NULL- Endator.
Rückgabewert
Die Funktion gibt einen der folgenden Werte zurück.
Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Wenn diese Funktion mit einer PathBuffer- von NULL- und einem PathBufferSize von 0 (null) aufgerufen wird, legt die Funktion die Puffergröße, die zum Speichern der angegebenen Daten in die Variable erforderlich ist, die durch PathRequiredSizeverweist.
Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR. Andernfalls ist der Rückgabewert einer der angegebenen Werte.
Um unzureichende Pufferfehler zu vermeiden, sollte ReturnBuffer- mindestens MAX_PATH sein.
Anmerkung
Der Header setupapi.h definiert SetupCopyError als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows XP [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows Server 2003 [Nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | setupapi.h |
| Library | Setupapi.lib |
| DLL- | Setupapi.dll |