Fonctions globales du Registre et de TypeLib
Ces fonctions prennent en charge le chargement et l’inscription d’une bibliothèque de types.
Important
Les fonctions répertoriées dans les tableaux suivants ne peuvent pas être utilisées dans les applications qui s’exécutent dans Windows Runtime.
Nom | Description |
---|---|
AfxRegCreateKey | Crée la clé de Registre spécifiée. |
AfxRegDeleteKey | Supprime la clé de Registre spécifiée. |
AfxRegisterPreviewHandler | Assistance pour inscrire un gestionnaire d’aperçu. |
AfxUnregisterPreviewHandler | Assistance pour annuler l’inscription d’un gestionnaire d’aperçu. |
AtlRegisterTypeLib | Cette fonction est appelée pour inscrire une bibliothèque de types. |
AtlUnRegisterTypeLib | Cette fonction est appelée pour annuler l’inscription d’une bibliothèque de types |
AfxRegOpenKey | Ouvre la clé de Registre spécifiée. |
AfxRegOpenKeyEx | Ouvre la clé de Registre spécifiée. |
AtlLoadTypeLib | Cette fonction est appelée pour charger une bibliothèque de types. |
AtlUpdateRegistryFromResourceD | Cette fonction est appelée pour mettre à jour le Registre à partir de la ressource fournie. |
RegistryDataExchange | Cette fonction est appelée pour lire ou écrire dans le Registre système. Appelé par les macros Exchange de données du Registre. |
Ces fonctions contrôlent le nœud du Registre que le programme utilise pour stocker des informations.
Nom | Description |
---|---|
AtlGetPerUserRegistration | Récupère si l’application redirige l’accès au Registre vers le nœud HKEY_CURRENT_USER ( HKCU). |
AtlSetPerUserRegistration | Définit si l’application redirige l’accès au Registre vers le nœud HKEY_CURRENT_USER ( HKCU). |
Spécifications
En-tête : atlbase.h
AtlGetPerUserRegistration
Utilisez cette fonction pour déterminer si l’application redirige l’accès au Registre vers le nœud HKEY_CURRENT_USER (HKCU).
Syntaxe
ATLINLINE ATLAPI AtlGetPerUserRegistration(bool* pEnabled);
Paramètres
pEnabled
[out] TRUE indique que les informations de Registre sont dirigées vers le nœud HKCU ; FALSE indique que l’application écrit des informations de Registre sur le nœud par défaut. Le nœud par défaut est HKEY_CLASSES_ROOT (HKCR).
Valeur de retour
S_OK si la méthode réussit, sinon le code d’erreur HRESULT s’il se produit une erreur.
Notes
La redirection du Registre n’est pas activée par défaut. Si vous activez cette option, l’accès au Registre est redirigé vers HKEY_CURRENT_USER\Software\Classes.
La redirection n’est pas globale. Seules les infrastructures MFC et ATL sont affectées par cette redirection de Registre.
Spécifications
En-tête : atlbase.h
AfxRegCreateKey
Crée la clé de Registre spécifiée.
Syntaxe
LONG AFXAPI AfxRegCreateKey(HKEY hKey, LPCTSTR lpSubKey, PHKEY phkResult, CAtlTransactionManager* pTM = NULL);
Paramètres
hKey
Handle vers une clé de Registre ouverte.
lpSubKey
Nom d’une clé que cette fonction ouvre ou crée.
phkResult
Pointeur vers une variable qui reçoit un handle vers la clé ouverte ou créée.
pTM
Pointeur vers un CAtlTransactionManager
objet.
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.
Spécifications
En-tête : afxpriv.h
AfxRegDeleteKey
Supprime la clé de Registre spécifiée.
Syntaxe
LONG AFXAPI AfxRegDeleteKey(HKEY hKey, LPCTSTR lpSubKey, CAtlTransactionManager* pTM = NULL);
Paramètres
hKey
Handle vers une clé de Registre ouverte.
lpSubKey
Nom de la clé à supprimer.
pTM
Pointeur vers un CAtlTransactionManager
objet.
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.
Spécifications
En-tête : afxpriv.h
Assistance pour inscrire un gestionnaire d’aperçu.
Syntaxe
BOOL AFXAPI AfxRegisterPreviewHandler(LPCTSTR lpszCLSID, LPCTSTR lpszShortTypeName, LPCTSTR lpszFilterExt);
Paramètres
lpszCLSID
Spécifie le CLSID du gestionnaire.
lpszShortTypeName
Spécifie le ProgID du gestionnaire.
lpszFilterExt
Spécifie l’extension de fichier inscrite auprès de ce gestionnaire.
Spécifications
En-tête : afxdisp.h
AtlRegisterTypeLib
Cette fonction est appelée pour inscrire une bibliothèque de types.
ATLAPI AtlRegisterTypeLib(HINSTANCE hInstTypeLib, LPCOLESTR lpszIndex);
Paramètres
hInstTypeLib
Handle de l’instance de module.
lpszIndex
Chaîne au format « \\N », où N est l’index entier de la ressource de bibliothèque de types. Peut être NULL si aucun index n’est requis.
Valeur de retour
Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.
Notes
Cette fonction d’assistance est utilisée par AtlComModuleUnregisterServer et CAtlComModule ::RegisterTypeLib.
Spécifications
En-tête : atlbase.h
AfxRegOpenKey
Ouvre la clé de Registre spécifiée.
Syntaxe
LONG AFXAPI AfxRegOpenKey(HKEY hKey, LPCTSTR lpSubKey, PHKEY phkResult, CAtlTransactionManager* pTM = NULL);
Paramètres
hKey
Handle vers une clé de Registre ouverte.
lpSubKey
Nom d’une clé que cette fonction ouvre ou crée.
phkResult
Pointeur vers une variable qui reçoit un handle vers la clé créée.
pTM
Pointeur vers un CAtlTransactionManager
objet.
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.
Spécifications
En-tête : afxpriv.h
AfxRegOpenKeyEx
Ouvre la clé de Registre spécifiée.
Syntaxe
LONG AFXAPI AfxRegOpenKeyEx(HKEY hKey, LPCTSTR lpSubKey, DWORD ulOptions, REGSAM samDesired, PHKEY phkResult, CAtlTransactionManager* pTM = NULL);
Paramètres
hKey
Handle vers une clé de Registre ouverte.
lpSubKey
Nom d’une clé que cette fonction ouvre ou crée.
ulOptions
Ce paramètre est réservé et doit être égal à zéro.
samDesired
Masque qui spécifie les droits d’accès souhaités à la clé.
phkResult
Pointeur vers une variable qui reçoit un handle vers la clé ouverte.
pTM
Pointeur vers un CAtlTransactionManager
objet.
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.
Spécifications
En-tête : afxpriv.h
AfxUnregisterPreviewHandler
Assistance pour annuler l’inscription d’un gestionnaire d’aperçu.
Syntaxe
BOOL AFXAPI AfxUnRegisterPreviewHandler(LPCTSTR lpszCLSID);
Paramètres
lpszCLSID
Spécifie le CLSID du gestionnaire à désinscrire.
Spécifications
En-tête : afxdisp.h
AtlSetPerUserRegistration
Définit si l’application redirige l’accès au Registre vers le nœud HKEY_CURRENT_USER (HKCU).
Syntaxe
ATLINLINE ATLAPI AtlSetPerUserRegistration(bool bEnable);
Paramètres
bEnable
[in] TRUE indique que les informations de Registre sont dirigées vers le nœud HKCU ; FALSE indique que l’application écrit des informations de Registre sur le nœud par défaut. Le nœud par défaut est HKEY_CLASSES_ROOT (HKCR).
Valeur de retour
S_OK si la méthode réussit, sinon le code d’erreur HRESULT s’il se produit une erreur.
Notes
La redirection du Registre n’est pas activée par défaut. Si vous activez cette option, l’accès au Registre est redirigé vers HKEY_CURRENT_USER\Software\Classes.
La redirection n’est pas globale. Seules les infrastructures MFC et ATL sont affectées par cette redirection de Registre.
Spécifications
En-tête : atlbase.h
AtlUnRegisterTypeLib
Cette fonction est appelée pour annuler l'inscription d'une bibliothèque de types.
Syntaxe
ATLAPI AtlUnRegisterTypeLib(
HINSTANCE hInstTypeLib,
LPCOLESTR lpszIndex);
Paramètres
hInstTypeLib
Handle de l’instance de module.
lpszIndex
Chaîne au format « \\N », où N est l’index entier de la ressource de bibliothèque de types. Peut être NULL si aucun index n’est requis.
Valeur de retour
Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.
Notes
Cette fonction d’assistance est utilisée par CAtlComModule ::UnRegisterTypeLib et AtlComModuleUnregisterServer.
Spécifications
En-tête : atlbase.h
AtlLoadTypeLib
Cette fonction est appelée pour charger une bibliothèque de types.
Syntaxe
ATLINLINE ATLAPI AtlLoadTypeLib(
HINSTANCE hInstTypeLib,
LPCOLESTR lpszIndex,
BSTR* pbstrPath,
ITypeLib** ppTypeLib);
Paramètres
hInstTypeLib
Gérer le module associé à la bibliothèque de types.
lpszIndex
Chaîne au format « \\N », où N est l’index entier de la ressource de bibliothèque de types. Peut être NULL si aucun index n’est requis.
pbstrPath
En cas de retour réussi, contient le chemin complet du module associé à la bibliothèque de types.
ppTypeLib
Lors du retour réussi, contient un pointeur vers un pointeur vers la bibliothèque de types chargée.
Valeur de retour
Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.
Notes
Cette fonction d’assistance est utilisée par AtlRegisterTypeLib et AtlUnRegisterTypeLib.
AtlUpdateRegistryFromResourceD
Cette fonction a été déconseillée dans Visual Studio 2013 et supprimée dans Visual Studio 2015.
<removed>
RegistryDataExchange
Cette fonction est appelée pour lire ou écrire dans le Registre système.
Syntaxe
HRESULT RegistryDataExchange(
T* pT,
enum RDXOperations rdxOp,
void* pItem = NULL);
Paramètres
Pt
Pointeur vers l’objet actuel.
rdxOp
Valeur d’énumération qui indique l’opération que la fonction doit effectuer. Consultez le tableau de la section Notes pour connaître les valeurs autorisées.
pItem
Pointeur vers les données à lire ou à écrire dans le Registre. Les données peuvent également représenter une clé à supprimer du Registre. La valeur par défaut est NULL.
Valeur de retour
Retourne S_OK en cas de réussite ou une erreur HRESULT en cas d’échec.
Notes
Les macros BEGIN_RDX_MAP et END_RDX_MAP développer sur une fonction qui appelle RegistryDataExchange
.
Les valeurs d’énumération possibles qui indiquent l’opération que la fonction doit effectuer sont indiquées dans le tableau suivant :
Valeur enum | Operation |
---|---|
eReadFromReg | Lit les données du Registre. |
eWriteToReg | Écrivez des données dans le Registre. |
eDeleteFromReg | Supprimez la clé du Registre. |
Spécifications
En-tête : atlbase.h