QueryCompressorInformation-Funktion (compressapi.h)

  • Artikel

Fragt einen Kompressor nach Informationen für einen bestimmten Komprimierungsalgorithmus ab.

Syntax

BOOL QueryCompressorInformation(
  [in]  COMPRESSOR_HANDLE          CompressorHandle,
  [in]  COMPRESS_INFORMATION_CLASS CompressInformationClass,
  [out] PVOID                      CompressInformation,
  [in]  SIZE_T                     CompressInformationSize
);

Parameter

[in] CompressorHandle

Handle an den Kompressor, der nach Informationen abgefragt wird.

[in] CompressInformationClass

Ein Wert der COMPRESS_INFORMATION_CLASS-Enumeration , die den Typ der Informationen angibt.

[out] CompressInformation

Informationen für den Komprimierungsalgorithmus, der als Bytes geschrieben wurde. Die maximale Größe dieser Informationen in Bytes wird von CompressInformationSize angegeben.

[in] CompressInformationSize

Maximale Größe der Informationen in Bytes.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null. Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Wenn der Komprimierungsalgorithmus aus einem internen Grund fehlschlägt, kann der Fehler von GetLastErrorERROR_FUNCTION_FAILED werden. Wenn das System das Komprimierungsalgorithmushandle nicht finden kann, kann der Fehler ERROR_INVALID_HANDLE werden. Wenn der Komprimierungsalgorithmus die Informationsklasse nicht zulässt, kann der Fehler ERROR_UNSUPPORTED_TYPE werden. Wenn der Puffer zu klein ist, um den Wert zu speichern, kann der Fehler ERROR_INSUFFICIENT_BUFFER werden.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 8 [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2012 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile compressapi.h
Bibliothek Cabinet.lib
DLL Cabinet.dll

Weitere Informationen

Komprimierungs-API-Funktionen