CAtlTransactionManager, classe
La classe CAtlTransactionManager fournit un wrapper aux fonctions KTM (Kernel Transaction Manager).
Important
Cette classe et ses membres ne peuvent pas être utilisés dans les applications qui s’exécutent dans Windows Runtime.
Syntaxe
class CAtlTransactionManager;
Membres
Constructeurs publics
| Nom | Description |
|---|---|
| ~CAtlTransactionManager | Destructeur CAtlTransactionManager. |
| CAtlTransactionManager | Constructeur CAtlTransactionManager. |
Méthodes publiques
| Nom | Description |
|---|---|
| Close | Ferme l’un des handles de transaction. |
| Commiter | Demande que la transaction soit validée. |
| Créer | Crée le handle de transaction. |
| CreateFile | Crée ou ouvre un fichier, un flux de fichiers ou un répertoire en tant qu’opération transactionnelle. |
| DeleteFile | Supprime un fichier existant en tant qu’opération transactionnelle. |
| FindFirstFile | Recherche un répertoire pour un fichier ou un sous-répertoire en tant qu’opération transactionnelle. |
| GetFileAttributes | Récupère les attributs du système de fichiers pour un fichier ou un répertoire spécifié en tant qu’opération transactionnelle. |
| GetFileAttributesEx | Récupère les attributs du système de fichiers pour un fichier ou un répertoire spécifié en tant qu’opération transactionnelle. |
| GetHandle | Retourne le handle de transaction. |
| IsFallback | Détermine si les appels de secours sont activés. |
| MoveFile | Déplace un fichier existant ou un répertoire, y compris ses enfants, en tant qu’opération transactionnelle. |
| RegCreateKeyEx | Crée la clé de Registre spécifiée et l’associe à une transaction. Si la clé existe déjà, la fonction l’ouvre. |
| RegDeleteKey | Supprime une sous-clé et ses valeurs de la vue spécifique à la plateforme spécifiée du Registre en tant qu’opération transactionnelle. |
| RegOpenKeyEx | Ouvre la clé de Registre spécifiée et l’associe à une transaction. |
| Restauration | Demande la restauration de la transaction. |
| SetFileAttributes | Définit les attributs d’un fichier ou d’un répertoire en tant qu’opération transactionnelle. |
Membres de données protégés
| Nom | Description |
|---|---|
| m_bFallback | TRUE si la secours est prise en charge ; FALSE dans le cas contraire. |
| m_hTransaction | Handle de transaction. |
Notes
Hiérarchie d'héritage
Spécifications
En-tête : atltransactionmanager.h
~CAtlTransactionManager
Destructeur CAtlTransactionManager.
virtual ~CAtlTransactionManager();
Notes
Dans le traitement normal, la transaction est automatiquement validée et fermée. Si le destructeur est appelé pendant un déroulement d’exception, la transaction est restaurée et fermée.
CAtlTransactionManager
Constructeur CAtlTransactionManager.
CAtlTransactionManager(BOOL bFallback = TRUE, BOOL bAutoCreateTransaction = TRUE);
Paramètres
bFallback
TRUE indique la prise en charge du secours. Si la fonction transactionnée échoue, la classe appelle automatiquement la fonction « non transactionnée ». FALSE indique qu’aucun appel de « secours » n’est indiqué.
bAutoCreateTransaction
TRUE indique que le gestionnaire de transactions est créé automatiquement dans le constructeur. FALSE indique qu’il n’est pas.
Notes
Clôture
Ferme le handle de transaction.
inline BOOL Close();
Valeur de retour
TRUE en cas de réussite, sinon FALSE.
Notes
Ce wrapper appelle la CloseHandle fonction. La méthode est automatiquement appelée dans le destructeur.
Validation
Demande que la transaction soit validée.
inline BOOL Commit();
Valeur de retour
TRUE en cas de réussite, sinon FALSE.
Notes
Ce wrapper appelle la CommitTransaction fonction. La méthode est automatiquement appelée dans le destructeur.
Créer
Crée le handle de transaction.
inline BOOL Create();
Valeur de retour
TRUE en cas de réussite, sinon FALSE.
Notes
Ce wrapper appelle la CreateTransaction fonction. Vérifiez-le
CreateFile
Crée ou ouvre un fichier, un flux de fichiers ou un répertoire en tant qu’opération transactionnelle.
inline HANDLE CreateFile(
LPCTSTR lpFileName,
DWORD dwDesiredAccess,
DWORD dwShareMode,
LPSECURITY_ATTRIBUTES lpSecurityAttributes,
DWORD dwCreationDisposition,
DWORD dwFlagsAndAttributes,
HANDLE hTemplateFile);
Paramètres
lpFileName
Nom d’un objet à créer ou ouvrir.
dwDesiredAccess
Accès à l’objet, qui peut être résumé en tant que lecture, écriture, les deux ou aucun (zéro). Les valeurs les plus couramment utilisées sont GENERIC_READ, GENERIC_WRITEou les deux : GENERIC_READ | GENERIC_WRITE.
dwShareMode
Mode de partage d’un objet, qui peut être lu, écrit, supprimer, tous ces éléments ou aucun : 0, FILE_SHARE_DELETE, FILE_SHARE_READ, FILE_SHARE_WRITE.
lpSecurityAttributes
Pointeur vers une structure SECURITY_ATTRIBUTES qui contient un descripteur de sécurité facultatif et détermine également si le handle retourné peut être hérité par les processus enfants. Le paramètre peut être NULL.
dwCreationDisposition
Action à entreprendre sur les fichiers qui existent et qui n’existent pas. Ce paramètre doit être l’une des valeurs suivantes, qui ne peuvent pas être combinées : CREATE_ALWAYS, CREATE_NEW, OPEN_ALWAYS, OPEN_EXISTING ou TRUNCATE_EXISTING.
dwFlagsAndAttributes
Attributs et indicateurs de fichier. Ce paramètre peut inclure n’importe quelle combinaison des attributs de fichier disponibles (FILE_ATTRIBUTE_*). Tous les autres attributs de fichier remplacent FILE_ATTRIBUTE_NORMAL. Ce paramètre peut également contenir des combinaisons d’indicateurs (FILE_FLAG_*) pour contrôler le comportement de mise en mémoire tampon, les modes d’accès et d’autres indicateurs à usage spécial. Ces valeurs s’associent à toutes les valeurs FILE_ATTRIBUTE_*.
hTemplateFile
Handle valide pour un fichier de modèle avec le droit d’accès GENERIC_READ. Le fichier de modèle fournit des attributs de fichier et des attributs étendus pour le fichier en cours de création. Ce paramètre peut être NULL.
Valeur de retour
Retourne un handle qui peut être utilisé pour accéder à l’objet.
Notes
Ce wrapper appelle la CreateFileTransacted fonction.
DeleteFile
Supprime un fichier existant en tant qu’opération transactionnelle.
inline BOOL DeleteFile(LPCTSTR lpFileName);
Paramètres
lpFileName
Nom du fichier à supprimer.
Notes
Ce wrapper appelle la DeleteFileTransacted fonction.
FindFirstFile
Recherche un répertoire pour un fichier ou un sous-répertoire en tant qu’opération transactionnelle.
inline HANDLE FindFirstFile(
LPCTSTR lpFileName,
WIN32_FIND_DATA* pNextInfo);
Paramètres
lpFileName
Répertoire ou chemin d’accès et nom de fichier à rechercher. Ce paramètre peut inclure des caractères génériques carte, tels qu’un astérisque (*) ou un point d’interrogation ().
pNextInfo
Pointeur vers la structure WIN32_FIND_DATA qui reçoit des informations sur un fichier ou un sous-répertoire trouvé.
Valeur de retour
Si la fonction réussit, la valeur de retour est un handle de recherche utilisé dans un appel ultérieur à FindNextFile ou FindClose. Si la fonction échoue ou ne parvient pas à localiser des fichiers à partir de la chaîne de recherche dans le paramètre lpFileName , la valeur de retour est INVALID_HANDLE_VALUE.
Notes
Ce wrapper appelle la FindFirstFileTransacted fonction.
GetFileAttributes
Récupère les attributs du système de fichiers pour un fichier ou un répertoire spécifié en tant qu’opération transactionnelle.
inline DWORD GetFileAttributes(LPCTSTR lpFileName);
Paramètres
lpFileName
Nom du fichier ou du répertoire.
Notes
Ce wrapper appelle la GetFileAttributesTransacted fonction.
GetFileAttributesEx
Récupère les attributs du système de fichiers pour un fichier ou un répertoire spécifié en tant qu’opération transactionnelle.
inline BOOL GetFileAttributesEx(
LPCTSTR lpFileName,
GET_FILEEX_INFO_LEVELS fInfoLevelId,
LPVOID lpFileInformation);
Paramètres
lpFileName
Nom du fichier ou du répertoire.
fInfoLevelId
Niveau d’informations d’attribut à récupérer.
lpFileInformation
Pointeur vers une mémoire tampon qui reçoit les informations d’attribut. Le type d’informations d’attribut stockées dans cette mémoire tampon est déterminé par la valeur de fInfoLevelId. Si le paramètre fInfoLevelId est GetFileExInfoStandard, ce paramètre pointe vers une structure WIN32_FILE_ATTRIBUTE_DATA.
Notes
Ce wrapper appelle la GetFileAttributesTransacted fonction.
GetHandle
Retourne le handle de transaction.
HANDLE GetHandle() const;
Valeur de retour
Retourne le handle de transaction d’une classe. Retourne NULL si l’élément CAtlTransactionManager n’est pas attaché à un handle.
Notes
IsFallback
Détermine si les appels de secours sont activés.
BOOL IsFallback() const;
Valeur de retour
Renvoie TRUE est que la classe prend en charge les appels de secours. FALSE dans le cas contraire.
Notes
m_bFallback
TRUE si la secours est prise en charge ; FALSE dans le cas contraire.
BOOL m_bFallback;
Notes
m_hTransaction
Handle de transaction.
HANDLE m_hTransaction;
Notes
MoveFile
Déplace un fichier existant ou un répertoire, y compris ses enfants, en tant qu’opération transactionnelle.
inline BOOL MoveFile(LPCTSTR lpOldFileName, LPCTSTR lpNewFileName);
Paramètres
lpOldFileName
Nom actuel du fichier ou du répertoire existant sur l’ordinateur local.
lpNewFileName
Nouveau nom du fichier ou du répertoire. Ce nom ne doit pas déjà exister. Un nouveau fichier peut se trouver sur un autre système de fichiers ou lecteur. Un nouveau répertoire doit se trouver sur le même lecteur.
Notes
Ce wrapper appelle la MoveFileTransacted fonction.
RegCreateKeyEx
Crée la clé de Registre spécifiée et l’associe à une transaction. Si la clé existe déjà, la fonction l’ouvre.
inline LSTATUS RegCreateKeyEx(
HKEY hKey,
LPCTSTR lpSubKey,
DWORD dwReserved,
LPTSTR lpClass,
DWORD dwOptions,
REGSAM samDesired,
CONST LPSECURITY_ATTRIBUTES lpSecurityAttributes,
PHKEY phkResult,
LPDWORD lpdwDisposition);
Paramètres
hKey
Handle vers une clé de Registre ouverte.
lpSubKey
Nom d’une sous-clé que cette fonction ouvre ou crée.
dwReserved
Ce paramètre est réservé et doit être égal à zéro.
lpClass
Classe définie par l’utilisateur de cette clé. Ce paramètre peut être ignoré. Ce paramètre peut être NULL.
dwOptions
Ce paramètre peut être l’une des valeurs suivantes : REG_OPTION_BACKUP_RESTORE, REG_OPTION_NON_VOLATILE ou REG_OPTION_VOLATILE.
samDesired
Masque qui spécifie les droits d’accès pour la clé.
lpSecurityAttributes
Pointeur vers une structure SECURITY_ATTRIBUTES qui détermine si le handle retourné peut être hérité par des processus enfants. Si lpSecurityAttributes a la valeur NULL, le handle ne peut pas être hérité.
phkResult
Pointeur vers une variable qui reçoit un handle vers la clé ouverte ou créée. Si la clé n’est pas l’une des clés de Registre prédéfinies, appelez la RegCloseKey fonction une fois que vous avez terminé d’utiliser le handle.
lpdwDisposition
Pointeur vers une variable qui reçoit l’une des valeurs de destruction suivantes : REG_CREATED_NEW_KEY ou REG_OPENED_EXISTING_KEY.
Valeur de retour
Si la fonction réussit, la valeur de retour est ERROR_SUCCESS. Si la fonction échoue, la valeur de retour est un code d’erreur différent de zéro défini dans Winerror.h.
Notes
Ce wrapper appelle la RegCreateKeyTransacted fonction.
RegDeleteKey
Supprime une sous-clé et ses valeurs de la vue spécifique à la plateforme spécifiée du Registre en tant qu’opération transactionnelle.
inline LSTATUS RegDeleteKeyEx(HKEY hKey, LPCTSTR lpSubKey);
Paramètres
hKey
Handle vers une clé de Registre ouverte.
lpSubKey
Nom de la clé à supprimer.
Valeur de retour
Si la fonction réussit, la valeur de retour est ERROR_SUCCESS. Si la fonction échoue, la valeur de retour est un code d’erreur différent de zéro défini dans Winerror.h.
Notes
Ce wrapper appelle la RegDeleteKeyTransacted fonction.
RegOpenKeyEx
Ouvre la clé de Registre spécifiée et l’associe à une transaction.
inline LSTATUS RegOpenKeyEx(
HKEY hKey,
LPCTSTR lpSubKey,
DWORD ulOptions,
REGSAM samDesired,
PHKEY phkResult);
Paramètres
hKey
Handle vers une clé de Registre ouverte.
lpSubKey
Nom de la sous-clé de Registre à ouvrir.
ulOptions
Ce paramètre est réservé et doit être égal à zéro.
samDesired
Masque qui spécifie les droits d’accès pour la clé.
phkResult
Pointeur vers une variable qui reçoit un handle vers la clé ouverte ou créée. Si la clé n’est pas l’une des clés de Registre prédéfinies, appelez la RegCloseKey fonction une fois que vous avez terminé d’utiliser le handle.
Valeur de retour
Si la fonction réussit, la valeur de retour est ERROR_SUCCESS. Si la fonction échoue, la valeur de retour est un code d’erreur différent de zéro défini dans Winerror.h
Notes
Ce wrapper appelle la RegOpenKeyTransacted fonction.
Restauration
Demande la restauration de la transaction.
inline BOOL Rollback();
Valeur de retour
TRUE en cas de réussite, sinon FALSE.
Notes
Ce wrapper appelle la RollbackTransaction fonction.
SetFileAttributes
Définit les attributs d’un fichier ou d’un répertoire en tant qu’opération transactionnelle.
inline BOOL SetFileAttributes(LPCTSTR lpFileName, DWORD dwAttributes);
Paramètres
lpFileName
Nom du fichier ou du répertoire.
dwAttributes
Attributs de fichier à définir pour le fichier. Pour plus d’informations, consultez SetFileAttributesTransacted.
Notes
Ce wrapper appelle la SetFileAttributesTransacted fonction.
Voir aussi
Commentaires
Bientôt disponible : Tout au long de l’année 2024, nous abandonnerons progressivement le mécanisme de retour d’information GitHub Issues pour le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez : https://aka.ms/ContentUserFeedback.
Soumettre et afficher des commentaires pour