Share via


QueryCompressorInformation, fonction (compressapi.h)

Interroge un compresseur pour obtenir des informations sur un algorithme de compression particulier.

Syntaxe

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

Paramètres

[in] CompressorHandle

Gérez le compresseur en cours d’interrogation pour obtenir des informations.

[in] CompressInformationClass

Valeur de l’énumération COMPRESS_INFORMATION_CLASS qui identifie le type d’informations.

[out] CompressInformation

Informations pour l’algorithme de compression écrit en octets. La taille maximale en octets de ces informations est indiquée par CompressInformationSize.

[in] CompressInformationSize

Taille maximale en octets des informations.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro. Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Si l’algorithme de compression échoue pour une raison interne, l’erreur de GetLastError peut être ERROR_FUNCTION_FAILED. Si le système ne peut pas localiser le handle de l’algorithme de compression, l’erreur peut être ERROR_INVALID_HANDLE. Si l’algorithme de compression n’autorise pas la classe d’informations, l’erreur peut être ERROR_UNSUPPORTED_TYPE. Si la mémoire tampon est trop petite pour contenir la valeur, l’erreur peut être ERROR_INSUFFICIENT_BUFFER.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 8 [applications de bureau | Applications UWP]
Serveur minimal pris en charge Windows Server 2012 [applications de bureau | Applications UWP]
Plateforme cible Windows
En-tête compressapi.h
Bibliothèque Cabinet.lib
DLL Cabinet.dll

Voir aussi

Fonctions de l’API de compression