CreateCompressor, fonction (compressapi.h)

  • Article

Génère une nouvelle COMPRESSOR_HANDLE.

Syntaxe

BOOL CreateCompressor(
  [in]           DWORD                         Algorithm,
  [in, optional] PCOMPRESS_ALLOCATION_ROUTINES AllocationRoutines,
  [out]          PCOMPRESSOR_HANDLE            CompressorHandle
);

Paramètres

[in] Algorithm

Type d’algorithme de compression et mode à utiliser par ce compresseur.

Vous pouvez éventuellement combiner l’une des valeurs suivantes avec l’indicateur COMPRESS_RAW . Utilisez un opérateur « OR au niveau du bit » pour inclure COMPRESS_RAW et créer un compresseur en mode bloc. Si COMPRESS_RAW n’est pas inclus, l’API Compression crée un compresseur en mode tampon. Pour plus d’informations sur la sélection d’un algorithme de compression et d’un mode, consultez Utilisation de l’API de compression.

Valeur Signification
COMPRESS_ALGORITHM_MSZIP
2
 Algorithme de compression MSZIP
COMPRESS_ALGORITHM_XPRESS
3
 Algorithme de compression XPRESS
COMPRESS_ALGORITHM_XPRESS_HUFF
4
 Algorithme de compression XPRESS avec encodage Huffman
COMPRESS_ALGORITHM_LZMS
5
 Algorithme de compression LZMS

[in, optional] AllocationRoutines

Routines facultatives d’allocation et de désallocation de mémoire dans une structure COMPRESS_ALLOCATION_ROUTINES .

[out] CompressorHandle

Si la fonction réussit, la poignée vers le compresseur spécifié.

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 trouve aucun algorithme de compression correspondant au nom et à la version spécifiés, l’erreur peut être ERROR_NOT_SUPPORTED.

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

COMPRESS_ALLOCATION_ROUTINES

Fonctions de l’API de compression