Win32 API 日本語リファレンス
ホームNetworking.ActiveDirectory › DsGetFriendlyClassName

DsGetFriendlyClassName

関数
オブジェクトクラスの表示用フレンドリ名を取得する。
DLLdsuiext.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// dsuiext.dll
#include <windows.h>

HRESULT DsGetFriendlyClassName(
    LPCWSTR pszObjectClass,
    LPWSTR pszBuffer,
    DWORD cchBuffer
);

パラメーター

名前方向説明
pszObjectClassLPCWSTRinわかりやすい名前へ変換する対象のオブジェクトクラス名。
pszBufferLPWSTRout取得した表示用クラス名を受け取るバッファ。
cchBufferDWORDinpszBufferの容量を文字数で指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

// dsuiext.dll
#include <windows.h>

HRESULT DsGetFriendlyClassName(
    LPCWSTR pszObjectClass,
    LPWSTR pszBuffer,
    DWORD cchBuffer
);
[DllImport("dsuiext.dll", ExactSpelling = true)]
static extern int DsGetFriendlyClassName(
    [MarshalAs(UnmanagedType.LPWStr)] string pszObjectClass,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuffer,   // LPWSTR out
    uint cchBuffer   // DWORD
);
<DllImport("dsuiext.dll", ExactSpelling:=True)>
Public Shared Function DsGetFriendlyClassName(
    <MarshalAs(UnmanagedType.LPWStr)> pszObjectClass As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszBuffer As System.Text.StringBuilder,   ' LPWSTR out
    cchBuffer As UInteger   ' DWORD
) As Integer
End Function
' pszObjectClass : LPCWSTR
' pszBuffer : LPWSTR out
' cchBuffer : DWORD
Declare PtrSafe Function DsGetFriendlyClassName Lib "dsuiext" ( _
    ByVal pszObjectClass As LongPtr, _
    ByVal pszBuffer As LongPtr, _
    ByVal cchBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsGetFriendlyClassName = ctypes.windll.dsuiext.DsGetFriendlyClassName
DsGetFriendlyClassName.restype = ctypes.c_int
DsGetFriendlyClassName.argtypes = [
    wintypes.LPCWSTR,  # pszObjectClass : LPCWSTR
    wintypes.LPWSTR,  # pszBuffer : LPWSTR out
    wintypes.DWORD,  # cchBuffer : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dsuiext.dll')
DsGetFriendlyClassName = Fiddle::Function.new(
  lib['DsGetFriendlyClassName'],
  [
    Fiddle::TYPE_VOIDP,  # pszObjectClass : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszBuffer : LPWSTR out
    -Fiddle::TYPE_INT,  # cchBuffer : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "dsuiext")]
extern "system" {
    fn DsGetFriendlyClassName(
        pszObjectClass: *const u16,  // LPCWSTR
        pszBuffer: *mut u16,  // LPWSTR out
        cchBuffer: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dsuiext.dll")]
public static extern int DsGetFriendlyClassName([MarshalAs(UnmanagedType.LPWStr)] string pszObjectClass, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuffer, uint cchBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dsuiext_DsGetFriendlyClassName' -Namespace Win32 -PassThru
# $api::DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer)
#uselib "dsuiext.dll"
#func global DsGetFriendlyClassName "DsGetFriendlyClassName" sptr, sptr, sptr
; DsGetFriendlyClassName pszObjectClass, varptr(pszBuffer), cchBuffer   ; 戻り値は stat
; pszObjectClass : LPCWSTR -> "sptr"
; pszBuffer : LPWSTR out -> "sptr"
; cchBuffer : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dsuiext.dll"
#cfunc global DsGetFriendlyClassName "DsGetFriendlyClassName" wstr, var, int
; res = DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer)
; pszObjectClass : LPCWSTR -> "wstr"
; pszBuffer : LPWSTR out -> "var"
; cchBuffer : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT DsGetFriendlyClassName(LPCWSTR pszObjectClass, LPWSTR pszBuffer, DWORD cchBuffer)
#uselib "dsuiext.dll"
#cfunc global DsGetFriendlyClassName "DsGetFriendlyClassName" wstr, var, int
; res = DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer)
; pszObjectClass : LPCWSTR -> "wstr"
; pszBuffer : LPWSTR out -> "var"
; cchBuffer : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dsuiext = windows.NewLazySystemDLL("dsuiext.dll")
	procDsGetFriendlyClassName = dsuiext.NewProc("DsGetFriendlyClassName")
)

// pszObjectClass (LPCWSTR), pszBuffer (LPWSTR out), cchBuffer (DWORD)
r1, _, err := procDsGetFriendlyClassName.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszObjectClass))),
	uintptr(pszBuffer),
	uintptr(cchBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function DsGetFriendlyClassName(
  pszObjectClass: PWideChar;   // LPCWSTR
  pszBuffer: PWideChar;   // LPWSTR out
  cchBuffer: DWORD   // DWORD
): Integer; stdcall;
  external 'dsuiext.dll' name 'DsGetFriendlyClassName';
result := DllCall("dsuiext\DsGetFriendlyClassName"
    , "WStr", pszObjectClass   ; LPCWSTR
    , "Ptr", pszBuffer   ; LPWSTR out
    , "UInt", cchBuffer   ; DWORD
    , "Int")   ; return: HRESULT
●DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer) = DLL("dsuiext.dll", "int DsGetFriendlyClassName(char*, char*, dword)")
# 呼び出し: DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer)
# pszObjectClass : LPCWSTR -> "char*"
# pszBuffer : LPWSTR out -> "char*"
# cchBuffer : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dsuiext" fn DsGetFriendlyClassName(
    pszObjectClass: [*c]const u16, // LPCWSTR
    pszBuffer: [*c]u16, // LPWSTR out
    cchBuffer: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc DsGetFriendlyClassName(
    pszObjectClass: WideCString,  # LPCWSTR
    pszBuffer: ptr uint16,  # LPWSTR out
    cchBuffer: uint32  # DWORD
): int32 {.importc: "DsGetFriendlyClassName", stdcall, dynlib: "dsuiext.dll".}
pragma(lib, "dsuiext");
extern(Windows)
int DsGetFriendlyClassName(
    const(wchar)* pszObjectClass,   // LPCWSTR
    wchar* pszBuffer,   // LPWSTR out
    uint cchBuffer   // DWORD
);
ccall((:DsGetFriendlyClassName, "dsuiext.dll"), stdcall, Int32,
      (Cwstring, Ptr{UInt16}, UInt32),
      pszObjectClass, pszBuffer, cchBuffer)
# pszObjectClass : LPCWSTR -> Cwstring
# pszBuffer : LPWSTR out -> Ptr{UInt16}
# cchBuffer : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DsGetFriendlyClassName(
    const uint16_t* pszObjectClass,
    uint16_t* pszBuffer,
    uint32_t cchBuffer);
]]
local dsuiext = ffi.load("dsuiext")
-- dsuiext.DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer)
-- pszObjectClass : LPCWSTR
-- pszBuffer : LPWSTR out
-- cchBuffer : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dsuiext.dll');
const DsGetFriendlyClassName = lib.func('__stdcall', 'DsGetFriendlyClassName', 'int32_t', ['str16', 'uint16_t *', 'uint32_t']);
// DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer)
// pszObjectClass : LPCWSTR -> 'str16'
// pszBuffer : LPWSTR out -> 'uint16_t *'
// cchBuffer : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dsuiext.dll", {
  DsGetFriendlyClassName: { parameters: ["buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer)
// pszObjectClass : LPCWSTR -> "buffer"
// pszBuffer : LPWSTR out -> "buffer"
// cchBuffer : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DsGetFriendlyClassName(
    const uint16_t* pszObjectClass,
    uint16_t* pszBuffer,
    uint32_t cchBuffer);
C, "dsuiext.dll");
// $ffi->DsGetFriendlyClassName(pszObjectClass, pszBuffer, cchBuffer);
// pszObjectClass : LPCWSTR
// pszBuffer : LPWSTR out
// cchBuffer : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Dsuiext extends StdCallLibrary {
    Dsuiext INSTANCE = Native.load("dsuiext", Dsuiext.class);
    int DsGetFriendlyClassName(
        WString pszObjectClass,   // LPCWSTR
        char[] pszBuffer,   // LPWSTR out
        int cchBuffer   // DWORD
    );
}
@[Link("dsuiext")]
lib Libdsuiext
  fun DsGetFriendlyClassName = DsGetFriendlyClassName(
    pszObjectClass : UInt16*,   # LPCWSTR
    pszBuffer : UInt16*,   # LPWSTR out
    cchBuffer : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsGetFriendlyClassNameNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef DsGetFriendlyClassNameDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final DsGetFriendlyClassName = DynamicLibrary.open('dsuiext.dll')
    .lookupFunction<DsGetFriendlyClassNameNative, DsGetFriendlyClassNameDart>('DsGetFriendlyClassName');
// pszObjectClass : LPCWSTR -> Pointer<Utf16>
// pszBuffer : LPWSTR out -> Pointer<Utf16>
// cchBuffer : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsGetFriendlyClassName(
  pszObjectClass: PWideChar;   // LPCWSTR
  pszBuffer: PWideChar;   // LPWSTR out
  cchBuffer: DWORD   // DWORD
): Integer; stdcall;
  external 'dsuiext.dll' name 'DsGetFriendlyClassName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsGetFriendlyClassName"
  c_DsGetFriendlyClassName :: CWString -> CWString -> Word32 -> IO Int32
-- pszObjectClass : LPCWSTR -> CWString
-- pszBuffer : LPWSTR out -> CWString
-- cchBuffer : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsgetfriendlyclassname =
  foreign "DsGetFriendlyClassName"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pszObjectClass : LPCWSTR -> (ptr uint16_t) *)
(* pszBuffer : LPWSTR out -> (ptr uint16_t) *)
(* cchBuffer : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dsuiext (t "dsuiext.dll"))
(cffi:use-foreign-library dsuiext)

(cffi:defcfun ("DsGetFriendlyClassName" ds-get-friendly-class-name :convention :stdcall) :int32
  (psz-object-class (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-buffer :pointer)   ; LPWSTR out
  (cch-buffer :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsGetFriendlyClassName = Win32::API::More->new('dsuiext',
    'int DsGetFriendlyClassName(LPCWSTR pszObjectClass, LPWSTR pszBuffer, DWORD cchBuffer)');
# my $ret = $DsGetFriendlyClassName->Call($pszObjectClass, $pszBuffer, $cchBuffer);
# pszObjectClass : LPCWSTR -> LPCWSTR
# pszBuffer : LPWSTR out -> LPWSTR
# cchBuffer : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。