Partager via

GetServiceDisplayNameA, fonction (winsvc.h)

  • Article

Récupère le nom d’affichage du service spécifié.

Syntaxe

BOOL GetServiceDisplayNameA(
  [in]            SC_HANDLE hSCManager,
  [in]            LPCSTR    lpServiceName,
  [out, optional] LPSTR     lpDisplayName,
  [in, out]       LPDWORD   lpcchBuffer
);

Paramètres

[in] hSCManager

Handle de la base de données du gestionnaire de contrôle de service, tel que retourné par la fonction OpenSCManager .

[in] lpServiceName

Nom du service. Ce nom est identique au nom de la clé de Registre du service. Il est préférable de choisir un nom de moins de 256 caractères.

[out, optional] lpDisplayName

Pointeur vers une mémoire tampon qui reçoit le nom d’affichage du service. Si la fonction échoue, cette mémoire tampon contiendra une chaîne vide.

La taille maximale de ce tableau est de 4 000 octets. Pour déterminer la taille requise, spécifiez NULL pour ce paramètre et 0 pour le paramètre lpcchBuffer . La fonction échoue et GetLastError retourne ERROR_INSUFFICIENT_BUFFER. Le paramètre lpcchBuffer reçoit la taille requise.

Ce paramètre peut spécifier une chaîne localisée au format suivant :

@[path]dllname,-strID

La chaîne avec l’identificateur strID est chargée à partir de dllname ; le chemin d’accès est facultatif. Pour plus d’informations, consultez RegLoadMUIString.

Windows Server 2003 et Windows XP : Les chaînes localisées ne sont pas prises en charge avant Windows Vista.

[in, out] lpcchBuffer

Pointeur vers une variable qui spécifie la taille de la mémoire tampon pointée vers lpDisplayName, dans les TCHAR.

À la sortie, cette variable reçoit la taille du nom d’affichage du service, en caractères, à l’exclusion du caractère de fin null.

Si la mémoire tampon pointée vers lpDisplayName est trop petite pour contenir le nom d’affichage, la fonction ne le stocke pas. Lorsque la fonction retourne, lpcchBuffer contient la taille du nom d’affichage du service, à l’exclusion du caractère de fin null.

Valeur retournée

Si les fonctions réussissent, 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

Il existe deux noms pour un service : le nom du service et le nom d’affichage. Le nom du service est le nom de la clé du service dans le Registre. Le nom d’affichage est un nom convivial qui apparaît dans l’application panneau de configuration Services et qui est utilisé avec la commande NET START . Pour mapper le nom du service au nom d’affichage, utilisez la fonction GetServiceDisplayName . Pour mapper le nom d’affichage au nom du service, utilisez la fonction GetServiceKeyName .

Notes

L’en-tête winsvc.h définit GetServiceDisplayName comme un 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.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête winsvc.h (inclure Windows.h)
Bibliothèque Advapi32.lib
DLL Advapi32.dll

Voir aussi

GetServiceKeyNameOpenSCManagerService Functions