SetupQueueCopyA-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 SetupQueueCopy--Funktion fügt einer Setupdateiwarteschlange einen einzelnen Dateikopievorgang hinzu.
Syntax
WINSETUPAPI BOOL SetupQueueCopyA(
[in] HSPFILEQ QueueHandle,
[in] PCSTR SourceRootPath,
[in] PCSTR SourcePath,
[in] PCSTR SourceFilename,
[in] PCSTR SourceDescription,
[in] PCSTR SourceTagfile,
[in] PCSTR TargetDirectory,
[in] PCSTR TargetFilename,
[in] DWORD CopyStyle
);
Parameter
[in] QueueHandle
Behandeln Sie eine Setupdateiwarteschlange, wie von SetupOpenFileQueuezurückgegeben.
[in] SourceRootPath
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den Stamm der Quelle für diese Kopie angibt, z. B. A:.
[in] SourcePath
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den Pfad relativ zu SourceRootPath- angibt, in dem die Datei gefunden werden kann. Dieser Parameter kann NULL-sein.
[in] SourceFilename
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den Dateinamenteil der zu kopierenden Datei angibt.
[in] SourceDescription
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die eine Beschreibung des Quellmediums angibt, das während der Datenträgeraufforderung verwendet werden soll. Dieser Parameter kann NULL-sein.
[in] SourceTagfile
Zeigen Sie auf eine null--terminated-Zeichenfolge, die eine Tagdatei angibt, deren Anwesenheit bei SourceRootPath- das Vorhandensein des Quellmediums angibt. Dieser Parameter kann NULL-sein. Wenn nicht angegeben, wird die Datei selbst bei Bedarf als Tagdatei verwendet.
[in] TargetDirectory
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die das Verzeichnis angibt, in das die Datei kopiert werden soll.
[in] TargetFilename
Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den Namen der Zieldatei angibt. Dieser Parameter kann NULL-sein. Wenn nicht angegeben, hat die Zieldatei denselben Namen wie die Quelldatei.
[in] CopyStyle
Gibt das Verhalten des Dateikopievorgangs an. Dieser Parameter kann eine Kombination aus den folgenden Werten sein.
SP_COPY_DELETESOURCE
Löschen Sie die Quelldatei nach erfolgreicher Kopie. Der Anrufer wird nicht benachrichtigt, wenn der Löschvorgang fehlschlägt.
SP_COPY_REPLACEONLY
Kopieren Sie die Datei nur, wenn dies geschieht, eine Datei im Zielpfad überschreiben würde. Der Anrufer wird nicht benachrichtigt.
SP_COPY_NEWER_OR IDENTISCH
Überprüfen Sie jede Datei, die kopiert wird, um festzustellen, ob die Versionsressourcen angeben, dass sie entweder die gleiche Oder nicht neuer als eine vorhandene Kopie des Ziels ist.
Die Dateiversionsinformationen, die bei Versionsüberprüfungen verwendet werden, sind die in der dwFileVersionMS und dwFileVersionLS Member einer VS_FIXEDFILEINFO Struktur angegeben, wie sie von den Versionsfunktionen ausgefüllt werden. Wenn eine der Dateien keine Versionsressourcen enthält oder identische Versionsinformationen enthalten, wird die Quelldatei als neuer betrachtet.
Wenn die Quelldatei in version oder neuer nicht gleich ist und CopyMsgHandler angegeben wird, wird der Aufrufer benachrichtigt und kann die Kopie abbrechen. Wenn CopyMsgHandler nicht angegeben ist, wird die Datei nicht kopiert.
SP_COPY_NEWER_ONLY
Überprüfen Sie jede Datei, die kopiert wird, um festzustellen, ob die Versionsressourcen angeben, dass sie nicht neuer als eine vorhandene Kopie des Ziels ist. Wenn die Quelldatei neuer, aber nicht gleich der Version des vorhandenen Ziels ist, wird die Datei kopiert.
SP_COPY_NOOVERWRITE
Überprüfen Sie, ob die Zieldatei vorhanden ist, und benachrichtigen Sie in diesem Fall den Anrufer, der die Kopie veto kann. Wenn CopyMsgHandler nicht angegeben ist, wird die Datei nicht überschrieben.
SP_COPY_NODECOMP
Dekomprimieren Sie die Datei nicht. Wenn dieses Flag festgelegt ist, erhält die Zieldatei nicht die nicht komprimierte Form des Quellnamens (falls zutreffend). Beispielsweise führt das Kopieren von f:\x86\cmd.ex_ zu \install\temp zu einer Zieldatei von \install\temp\cmd.ex_. Wenn das SP_COPY_NODECOMP Flag nicht angegeben wurde, wird die Datei dekomprimiert, und das Ziel wird \install\temp\cmd.exeaufgerufen. Der Dateinameteil von DestinationName, falls angegeben, wird entfernt und durch den Dateinamen der Quelldatei ersetzt. Wenn SP_COPY_NODECOMP angegeben ist, können keine Sprach- oder Versionsinformationen überprüft werden.
SP_COPY_LANGUAGEAWARE
Überprüfen Sie jede Datei, die kopiert wird, um festzustellen, ob sich ihre Sprache von der Sprache einer vorhandenen Datei unterscheidet, die sich bereits auf dem Ziel befindet. Wenn ja, und CopyMsgHandler angegeben ist, wird der Aufrufer benachrichtigt und kann die Kopie abbrechen. Wenn CopyMsgHandler nicht angegeben ist, wird die Datei nicht kopiert.
SP_COPY_SOURCE_ABSOLUTE
SourceFile- ist ein vollständiger Quellpfad. Suchen Sie sie nicht im SourceDisksNames Abschnitt der INF-Datei nach.
SP_COPY_SOURCEPATH_ABSOLUTE
SourcePathRoot- ist der vollständige Pfadteil der Quelldatei. Ignorieren Sie die relative Quelle, die in der SourceDisksNames Abschnitt der INF-Datei für die Quellmedien angegeben ist, in der sich die Datei befindet. Dieses Kennzeichen wird ignoriert, wenn SP_COPY_SOURCE_ABSOLUTE angegeben wird.
SP_COPY_FORCE_IN_USE
Wenn das Ziel vorhanden ist, verhalten Sie sich so, als ob sie verwendet wird, und stellen Sie die Datei zum Kopieren im nächsten Systemneustart in die Warteschlange.
SP_COPY_IN_USE_NEEDS_REBOOT
Wenn die Datei während des Kopiervorgangs verwendet wurde, benachrichtigen Sie den Benutzer, dass das System neu gestartet werden muss.
SP_COPY_NOSKIP
Geben Sie dem Benutzer nicht die Möglichkeit, eine Datei zu überspringen.
SP_COPY_FORCE_NOOVERWRITE
Überprüfen Sie, ob die Zieldatei vorhanden ist, und wenn ja, wird die Datei nicht überschrieben. Der Anrufer wird nicht benachrichtigt.
SP_COPY_FORCE_NEWER
Überprüfen Sie jede datei, die kopiert wird, um festzustellen, ob ihre Versionsressourcen (oder Zeitstempel für Nicht-Bilddateien) angeben, dass sie nicht neuer als eine vorhandene Kopie des Ziels ist. Wenn die kopierte Datei nicht neuer ist, wird die Datei nicht kopiert. Der Anrufer wird nicht benachrichtigt.
SP_COPY_WARNIFSKIP
Wenn der Benutzer versucht, eine Datei zu überspringen, warnen Sie, dass sich das Überspringen einer Datei auf die Installation auswirken kann. (Wird für systemkritische Dateien verwendet.)
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Wenn ein UNC-Verzeichnis als Zielverzeichnis eines Dateikopievorgangs angegeben ist, müssen Sie sicherstellen, dass es vorhanden ist, bevor die Warteschlange zugesichert wird. Die Setupfunktionen überprüfen nicht, ob UNC-Verzeichnisse vorhanden sind und nicht erstellt werden. Wenn das UNC-Zielverzeichnis nicht vorhanden ist, schlägt die Dateikopie fehl.
Anmerkung
Der header setupapi.h definiert SetupQueueCopy 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 |