GetCompressedFileSizeTransactedW, fonction (winbase.h)

Article
11/20/2024

[Microsoft recommande vivement aux développeurs d’utiliser d’autres moyens pour répondre aux besoins de votre application. De nombreux scénarios développés par TxF peuvent être réalisés par le biais de techniques plus simples et plus facilement disponibles. En outre, TxF peut ne pas être disponible dans les futures versions de Microsoft Windows. Pour plus d’informations et d’alternatives à TxF, consultez Alternatives à l’utilisation de NTFS transactionnel.]

Récupère le nombre réel d’octets du stockage sur disque utilisé pour stocker un fichier spécifié en tant qu’opération transactionnelle. Si le fichier se trouve sur un volume qui prend en charge la compression et que le fichier est compressé, la valeur obtenue est la taille compressée du fichier spécifié. Si le fichier se trouve sur un volume qui prend en charge les fichiers partiellement alloués et que le fichier est un fichier partiellement alloué, la valeur obtenue est la taille éparse du fichier spécifié.

Syntaxe

DWORD GetCompressedFileSizeTransactedW(
  [in]            LPCWSTR lpFileName,
  [out, optional] LPDWORD lpFileSizeHigh,
  [in]            HANDLE  hTransaction
);

Paramètres

[in] lpFileName

Nom du fichier.

Ne spécifiez pas le nom d’un fichier sur un appareil non manuscrit, tel qu’un canal ou un appareil de communication, car sa taille de fichier n’a aucune signification.

Le fichier doit résider sur l’ordinateur local ; sinon, la fonction échoue et le dernier code d’erreur est défini sur ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE.

[out, optional] lpFileSizeHigh

Pointeur vers une variable qui reçoit l’ordre élevé DWORD de la taille de fichier compressée. La valeur de retour de la fonction est la valeur de faible ordre DWORD de la taille de fichier compressée.

Ce paramètre peut être null si l’ordre élevé DWORD de la taille de fichier compressé n’est pas nécessaire. Les fichiers de taille inférieure à 4 gigaoctets n’ont pas besoin de l’ordre élevé DWORD.

[in] hTransaction

Handle de la transaction. Ce handle est retourné par la fonction CreateTransaction.

Valeur de retour

Si la fonction réussit, la valeur de retour est la valeur de faible ordre DWORD du nombre réel d’octets de stockage de disque utilisé pour stocker le fichier spécifié, et si lpFileSizeHigh n’est pasNULL, la fonction place l’ordre élevé DWORD de cette valeur réelle dans le DWORD pointé par ce paramètre. Il s’agit de la taille du fichier compressé pour les fichiers compressés, la taille réelle des fichiers non compressés.

Si la fonction échoue et que lpFileSizeHigh est NULL, la valeur de retour est INVALID_FILE_SIZE. Pour obtenir des informations d’erreur étendues, appelez GetLastError.

Si la valeur de retour est INVALID_FILE_SIZE et lpFileSizeHigh n’est pasnull, une application doit appeler GetLastError pour déterminer si la fonction a réussi (la valeur est NO_ERROR) ou a échoué (la valeur est différente de NO_ERROR).

Remarques

Une application peut déterminer si un volume est compressé en appelant GetVolumeInformation, puis en vérifiant l’état de l’indicateur de FS_VOL_IS_COMPRESSED dans la valeur DWORD pointée par le paramètre lpFileSystemFlags de cette fonction.

Si le fichier n’est pas situé sur un volume qui prend en charge la compression ou les fichiers partiellement alloués, ou si le fichier n’est pas compressé ou un fichier partiellement alloué, la valeur obtenue est la taille réelle du fichier, identique à la valeur retournée par un appel à GetFileSize.

liens symboliques : Si le chemin pointe vers un lien symbolique, la fonction retourne la taille de fichier de la cible.

Dans Windows 8 et Windows Server 2012, cette fonction est prise en charge par les technologies suivantes.

Technologie	Supporté
Protocole SMB (Server Message Block) 3.0	Non
Basculement transparent SMB 3.0 (TFO)	Non
SMB 3.0 avec partages de fichiers avec montée en puissance parallèle (SO)	Non
Cluster Shared Volume File System (CsvFS)	Non
Système de fichiers résilient (ReFS)	Non

SMB 3.0 ne prend pas en charge TxF.

Note

L’en-tête winbase.h définit GetCompressedFileSizeTransacted comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows Vista [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2008 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	winbase.h (inclure Windows.h)
bibliothèque	Kernel32.lib
DLL	Kernel32.dll