ホーム › System.Services › GetServiceDisplayNameW

GetServiceDisplayNameW

関数

サービスのキー名から表示名を取得する。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetServiceDisplayNameW(
    SC_HANDLE hSCManager,
    LPCWSTR lpServiceName,
    LPWSTR lpDisplayName,   // optional
    DWORD* lpcchBuffer
);

パラメーター

名前	型	方向	説明
hSCManager	SC_HANDLE	in	サービス制御マネージャーデータベースへのハンドル。 OpenSCManager 関数によって返されます。
lpServiceName	LPCWSTR	in	サービス名。この名前はサービスのレジストリキー名と同じです。256 文字未満の名前を選択することを推奨します。
lpDisplayName	LPWSTR	outoptional	サービスの表示名を受け取るバッファーへのポインター。関数が失敗した場合、このバッファーには空の文字列が格納されます。この配列の最大サイズは 4K バイトです。必要なサイズを確認するには、このパラメーターに NULL を、lpcchBuffer パラメーターに 0 を指定します。関数は失敗し、GetLastError は ERROR_INSUFFICIENT_BUFFER を返します。lpcchBuffer パラメーターは必要なサイズを受け取ります。このパラメーターでは、次の形式を使用してローカライズされた文字列を指定できます。 @[path]dllname,-strID 識別子 strID を持つ文字列が dllname から読み込まれます。path は省略可能です。詳細については、RegLoadMUIString を参照してください。 Windows Server 2003 および Windows XP: ローカライズされた文字列は Windows Vista までサポートされていません。
lpcchBuffer	DWORD*	inout	lpDisplayName が指すバッファーのサイズを TCHAR 単位で指定する変数へのポインター。出力時、この変数はサービスの表示名のサイズを文字数で受け取ります(null 終端文字は含みません)。 lpDisplayName が指すバッファーが表示名を格納するには小さすぎる場合、関数は表示名を格納しません。関数が戻るとき、lpcchBuffer にはサービスの表示名のサイズが格納されます(null 終端文字は含みません)。

戻り値の型: BOOL

公式ドキュメント

指定したサービスの表示名を取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

サービスには 2 つの名前があります。サービス名と表示名です。サービス名はレジストリ内のサービスのキーの名前です。表示名は、サービスコントロールパネルアプリケーションに表示されるわかりやすい名前で、NET START コマンドで使用されます。サービス名を表示名にマップするには、 GetServiceDisplayName 関数を使用します。表示名をサービス名にマップするには、 GetServiceKeyName 関数を使用します。

メモ

winsvc.h ヘッダーは GetServiceDisplayName を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディングニュートラルなエイリアスの使用と、エンコーディングニュートラルでないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetServiceDisplayNameW(
    SC_HANDLE hSCManager,
    LPCWSTR lpServiceName,
    LPWSTR lpDisplayName,   // optional
    DWORD* lpcchBuffer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetServiceDisplayNameW(
    IntPtr hSCManager,   // SC_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string lpServiceName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDisplayName,   // LPWSTR optional, out
    ref uint lpcchBuffer   // DWORD* in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetServiceDisplayNameW(
    hSCManager As IntPtr,   ' SC_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpServiceName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpDisplayName As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef lpcchBuffer As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hSCManager : SC_HANDLE
' lpServiceName : LPCWSTR
' lpDisplayName : LPWSTR optional, out
' lpcchBuffer : DWORD* in/out
Declare PtrSafe Function GetServiceDisplayNameW Lib "advapi32" ( _
    ByVal hSCManager As LongPtr, _
    ByVal lpServiceName As LongPtr, _
    ByVal lpDisplayName As LongPtr, _
    ByRef lpcchBuffer As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetServiceDisplayNameW = ctypes.windll.advapi32.GetServiceDisplayNameW
GetServiceDisplayNameW.restype = wintypes.BOOL
GetServiceDisplayNameW.argtypes = [
    wintypes.HANDLE,  # hSCManager : SC_HANDLE
    wintypes.LPCWSTR,  # lpServiceName : LPCWSTR
    wintypes.LPWSTR,  # lpDisplayName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcchBuffer : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetServiceDisplayNameW = Fiddle::Function.new(
  lib['GetServiceDisplayNameW'],
  [
    Fiddle::TYPE_VOIDP,  # hSCManager : SC_HANDLE
    Fiddle::TYPE_VOIDP,  # lpServiceName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpDisplayName : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcchBuffer : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn GetServiceDisplayNameW(
        hSCManager: *mut core::ffi::c_void,  // SC_HANDLE
        lpServiceName: *const u16,  // LPCWSTR
        lpDisplayName: *mut u16,  // LPWSTR optional, out
        lpcchBuffer: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetServiceDisplayNameW(IntPtr hSCManager, [MarshalAs(UnmanagedType.LPWStr)] string lpServiceName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDisplayName, ref uint lpcchBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetServiceDisplayNameW' -Namespace Win32 -PassThru
# $api::GetServiceDisplayNameW(hSCManager, lpServiceName, lpDisplayName, lpcchBuffer)

#uselib "ADVAPI32.dll"
#func global GetServiceDisplayNameW "GetServiceDisplayNameW" wptr, wptr, wptr, wptr
; GetServiceDisplayNameW hSCManager, lpServiceName, varptr(lpDisplayName), varptr(lpcchBuffer)   ; 戻り値は stat
; hSCManager : SC_HANDLE -> "wptr"
; lpServiceName : LPCWSTR -> "wptr"
; lpDisplayName : LPWSTR optional, out -> "wptr"
; lpcchBuffer : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global GetServiceDisplayNameW "GetServiceDisplayNameW" sptr, wstr, var, var
; res = GetServiceDisplayNameW(hSCManager, lpServiceName, lpDisplayName, lpcchBuffer)
; hSCManager : SC_HANDLE -> "sptr"
; lpServiceName : LPCWSTR -> "wstr"
; lpDisplayName : LPWSTR optional, out -> "var"
; lpcchBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global GetServiceDisplayNameW "GetServiceDisplayNameW" sptr, wstr, sptr, sptr
; res = GetServiceDisplayNameW(hSCManager, lpServiceName, varptr(lpDisplayName), varptr(lpcchBuffer))
; hSCManager : SC_HANDLE -> "sptr"
; lpServiceName : LPCWSTR -> "wstr"
; lpDisplayName : LPWSTR optional, out -> "sptr"
; lpcchBuffer : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。