SetupPromptForDiskA-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 SetupPromptForDisk--Funktion zeigt ein Dialogfeld an, in dem der Benutzer zur Eingabe eines Datenträgers aufgefordert wird.
Syntax
WINSETUPAPI UINT SetupPromptForDiskA(
[in] HWND hwndParent,
[in] PCSTR DialogTitle,
[in] PCSTR DiskName,
[in] PCSTR PathToSource,
[in] PCSTR FileSought,
[in] PCSTR TagFile,
[in] DWORD DiskPromptStyle,
[in, out] PSTR PathBuffer,
[in] DWORD PathBufferSize,
[in, out] PDWORD PathRequiredSize
);
Parameter
[in] hwndParent
Behandeln Des übergeordneten Fensters für dieses Dialogfeld.
[in] DialogTitle
Optionaler Zeiger auf eine NULL--terminated-Zeichenfolge, die den Dialogtitel angibt. Wenn dieser Parameter NULL-ist, wird der Standardwert von ""%s--Files Needed"" (lokalisiert) verwendet. Das "%s" wird durch den Text ersetzt, der aus dem übergeordneten Fenster abgerufen wurde. Wenn kein Text aus dem übergeordneten Fenster abgerufen wird, lautet der Titel "Dateien erforderlich".
[in] DiskName
Optionaler Zeiger auf eine NULL--terminated-Zeichenfolge, die den Namen des einzufügenden Datenträgers angibt. Wenn dieser Parameter NULL-ist, wird die Standardeinstellung "(Unbekannt)" (lokalisiert) verwendet.
[in] PathToSource
Optionaler Zeiger auf eine NULL--terminated-Zeichenfolge, die den Pfadteil des erwarteten Speicherorts der Datei angibt, z. B. F:\x86. Wenn nicht angegeben, wird der Pfad, in dem SetupPromptForDisk zuletzt eine Datei gespeichert wird, verwendet. Wenn diese Liste leer ist, wird ein Systemstandard verwendet.
[in] FileSought
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den Namen der benötigten Datei angibt (nur Dateinameteil). Der Dateiname wird angezeigt, wenn der Benutzer auf die Schaltfläche Durchsuchen klickt. Diese Routine sucht anhand der komprimierten Formularnamen nach der Datei. 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] TagFile
Optionaler Zeiger auf eine NULL--terminated-Zeichenfolge, die eine Tagdatei angibt (nur Dateiname-Teil), die das Vorhandensein eines bestimmten Wechselmedienvolumes identifiziert. Wenn der aktuell ausgewählte Pfad die Datei auf Wechselmedien platziert und eine Tagdatei angegeben wird, sucht SetupPromptForDisk nach der Tagdatei im Stammverzeichnis des Laufwerks, um zu bestimmen, ob der Vorgang fortgesetzt werden soll.
Wenn PathToSource- beispielsweise A:\x86 lautet, ist die Tagdatei "disk1.tag", und der Benutzer gibt "B:\x86" in das Bearbeitungssteuerelement des Eingabeaufforderungsdialogfelds ein, sucht die Routine nach "B:\disk1.tag", um zu bestimmen, ob der Vorgang fortgesetzt werden soll. Wenn die Tagdatei nicht gefunden wird, sucht die Funktion mithilfe PathToSource-nach der Tagdatei.
Wenn keine Tagdatei angegeben ist, funktionieren Wechselmedien genauso wie Wechselmedien, und FileSought gesucht wird, bevor Sie fortfahren.
[in] DiskPromptStyle
Gibt das Verhalten des Dialogfelds an. Dieser Parameter kann eine Kombination aus den folgenden Flags sein.
IDF_CHECKFIRST
Überprüfen Sie, ob die Datei/der Datenträger angezeigt wird, bevor Sie das Eingabeaufforderungsdialogfeld anzeigen, und geben Sie, falls vorhanden, DPROMPT_SUCCESS sofort zurück.
IDF_NOBEEP
Verhindern, dass das Dialogfeld beim ersten Anzeigen die Aufmerksamkeit des Benutzers erhält.
IDF_NOBROWSE
Die Suchoption wird nicht angezeigt.
IDF_NOCOMPRESSED
Überprüfen Sie nicht auf komprimierte Versionen der Quelldatei.
IDF_NODETAILS
Keine Detailinformationen anzeigen.
IDF_NOFOREGROUND
Verhindern, dass das Dialogfeld zum Vordergrundfenster wird.
IDF_NOSKIP
Die Option "Überspringen" wird nicht angezeigt.
IDF_OEMDISK
Fordern Sie einen Datenträger auf, der von einem Hardwarehersteller bereitgestellt wird.
IDF_WARNIFSKIP
Warnen Sie den Benutzer, dass sich das Überspringen einer Datei auf die Installation auswirken kann.
[in, out] PathBuffer
Optionaler Zeiger auf einen Puffer, der beim Zurückgeben den Pfad (kein Dateiname) des vom Benutzer angegebenen Speicherorts über das Dialogfeld empfängt. Sie sollten eine null--terminated-Zeichenfolge verwenden. Die null-terminated string sollte die Größe des Zielpuffers nicht überschreiten. Sie können die Funktion einmal aufrufen, um die erforderliche Puffergröße abzurufen, den erforderlichen Arbeitsspeicher zuzuweisen und dann die Funktion ein zweites Mal aufzurufen, um die Daten abzurufen. Mithilfe dieser Technik können Sie Fehler aufgrund einer unzureichenden Puffergröße vermeiden. Weitere Informationen finden Sie im Abschnitt "Hinweise".
[in] PathBufferSize
Größe des Puffers, auf den durch PathBufferin Zeichen verwiesen wird. Es sollte mindestens MAX_PATH lang sein. Dies schließt den null Terminator ein.
[in, out] PathRequiredSize
Optionaler Zeiger auf eine Variable, die die erforderliche Größe für PathBuffer-in Zeichen empfängt. Dies schließt den null Terminator ein.
Rückgabewert
Die Funktion gibt einen der folgenden Werte zurück.
Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Wenn diese Funktion mit einem PathBuffer-NULL- und einem PathBufferSize null aufgerufen wird, fügt die Funktion die puffergröße ein, die benötigt wird, um die angegebenen Daten in die Variable einzuspeichern, auf die PathRequiredSizeverweist. Wenn die Funktion erfolgreich ausgeführt wird, wird der Rückgabewert NO_ERROR. Andernfalls ist der Rückgabewert einer der im Abschnitt "Rückgabewerte" beschriebenen Werte.
Anmerkung
Der header setupapi.h definiert SetupPromptForDisk 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 |