Freigeben über


GetServiceDisplayNameA-Funktion (winsvc.h)

Ruft den Anzeigenamen des angegebenen Diensts ab.

Syntax

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

Parameter

[in] hSCManager

Ein Handle für die Dienststeuerungs-Manager-Datenbank, wie es von der OpenSCManager-Funktion zurückgegeben wird.

[in] lpServiceName

Der Name des Diensts. Dieser Name entspricht dem Namen des Registrierungsschlüssels des Diensts. Es empfiehlt sich, einen Namen auszuwählen, der weniger als 256 Zeichen lang ist.

[out, optional] lpDisplayName

Ein Zeiger auf einen Puffer, der den Anzeigenamen des Diensts empfängt. Wenn die Funktion fehlschlägt, enthält dieser Puffer eine leere Zeichenfolge.

Die maximale Größe dieses Arrays beträgt 4K Bytes. Geben Sie null für diesen Parameter und 0 für den lpcchBuffer-Parameter an, um die erforderliche Größe zu bestimmen. Die Funktion schlägt fehl, und GetLastError gibt ERROR_INSUFFICIENT_BUFFER zurück. Der lpcchBuffer-Parameter erhält die erforderliche Größe.

Dieser Parameter kann eine lokalisierte Zeichenfolge im folgenden Format angeben:

@[Path]dllname,-strID

Die Zeichenfolge mit dem Bezeichner strID wird aus dllname geladen. der Pfad ist optional. Weitere Informationen finden Sie unter RegLoadMUIString.

Windows Server 2003 und Windows XP: Lokalisierte Zeichenfolgen werden erst unter Windows Vista unterstützt.

[in, out] lpcchBuffer

Ein Zeiger auf eine Variable, die die Größe des Puffers angibt, auf den lpDisplayName in TCHARs verweist.

Bei der Ausgabe empfängt diese Variable die Größe des Anzeigenamens des Diensts in Zeichen, mit Ausnahme des Nullabschlusszeichens.

Wenn der Puffer, auf den lpDisplayName verweist, zu klein ist, um den Anzeigenamen zu enthalten, speichert die Funktion ihn nicht. Wenn die Funktion zurückgibt, enthält lpcchBuffer die Größe des Anzeigenamens des Diensts, mit Ausnahme des Nullabschlusszeichens.

Rückgabewert

Wenn die Funktionen erfolgreich sind, ist der Rückgabewert ungleich null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Es gibt zwei Namen für einen Dienst: den Dienstnamen und den Anzeigenamen. Der Dienstname ist der Name des Dienstschlüssels in der Registrierung. Der Anzeigename ist ein benutzerfreundlicher Name, der in der Systemsteuerungsanwendung Dienste angezeigt wird und mit dem NET START-Befehl verwendet wird. Verwenden Sie die GetServiceDisplayName-Funktion , um den Dienstnamen dem Anzeigenamen zuzuordnen. Verwenden Sie die GetServiceKeyName-Funktion , um den Anzeigenamen dem Dienstnamen zuzuordnen.

Hinweis

Der winsvc.h-Header definiert GetServiceDisplayName als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile winsvc.h (windows.h einschließen)
Bibliothek Advapi32.lib
DLL Advapi32.dll

Weitere Informationen

GetServiceKeyNameOpenSCManager-Dienstfunktionen