Win32 API 日本語リファレンス
ホームUI.Accessibility › GetRoleTextW

GetRoleTextW

関数
アクセシビリティのロールIDの説明文字列(Unicode)を取得する。
DLLOLEACC.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

DWORD GetRoleTextW(
    DWORD lRole,
    LPWSTR lpszRole,   // optional
    DWORD cchRoleMax
);

パラメーター

名前方向説明
lRoleDWORDinテキストを取得するロール識別子(ROLE_SYSTEM_*)。
lpszRoleLPWSTRoutoptional出力としてロール説明文字列を受け取るバッファ(Unicode)。NULLで必要長取得。
cchRoleMaxDWORDinlpszRoleバッファの文字数(NUL終端含む)。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetRoleTextW(
    DWORD lRole,
    LPWSTR lpszRole,   // optional
    DWORD cchRoleMax
);
[DllImport("OLEACC.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetRoleTextW(
    uint lRole,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszRole,   // LPWSTR optional, out
    uint cchRoleMax   // DWORD
);
<DllImport("OLEACC.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetRoleTextW(
    lRole As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpszRole As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchRoleMax As UInteger   ' DWORD
) As UInteger
End Function
' lRole : DWORD
' lpszRole : LPWSTR optional, out
' cchRoleMax : DWORD
Declare PtrSafe Function GetRoleTextW Lib "oleacc" ( _
    ByVal lRole As Long, _
    ByVal lpszRole As LongPtr, _
    ByVal cchRoleMax 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

GetRoleTextW = ctypes.windll.oleacc.GetRoleTextW
GetRoleTextW.restype = wintypes.DWORD
GetRoleTextW.argtypes = [
    wintypes.DWORD,  # lRole : DWORD
    wintypes.LPWSTR,  # lpszRole : LPWSTR optional, out
    wintypes.DWORD,  # cchRoleMax : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEACC.dll')
GetRoleTextW = Fiddle::Function.new(
  lib['GetRoleTextW'],
  [
    -Fiddle::TYPE_INT,  # lRole : DWORD
    Fiddle::TYPE_VOIDP,  # lpszRole : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # cchRoleMax : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "oleacc")]
extern "system" {
    fn GetRoleTextW(
        lRole: u32,  // DWORD
        lpszRole: *mut u16,  // LPWSTR optional, out
        cchRoleMax: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEACC.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetRoleTextW(uint lRole, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszRole, uint cchRoleMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEACC_GetRoleTextW' -Namespace Win32 -PassThru
# $api::GetRoleTextW(lRole, lpszRole, cchRoleMax)
#uselib "OLEACC.dll"
#func global GetRoleTextW "GetRoleTextW" wptr, wptr, wptr
; GetRoleTextW lRole, varptr(lpszRole), cchRoleMax   ; 戻り値は stat
; lRole : DWORD -> "wptr"
; lpszRole : LPWSTR optional, out -> "wptr"
; cchRoleMax : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLEACC.dll"
#cfunc global GetRoleTextW "GetRoleTextW" int, var, int
; res = GetRoleTextW(lRole, lpszRole, cchRoleMax)
; lRole : DWORD -> "int"
; lpszRole : LPWSTR optional, out -> "var"
; cchRoleMax : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetRoleTextW(DWORD lRole, LPWSTR lpszRole, DWORD cchRoleMax)
#uselib "OLEACC.dll"
#cfunc global GetRoleTextW "GetRoleTextW" int, var, int
; res = GetRoleTextW(lRole, lpszRole, cchRoleMax)
; lRole : DWORD -> "int"
; lpszRole : LPWSTR optional, out -> "var"
; cchRoleMax : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleacc = windows.NewLazySystemDLL("OLEACC.dll")
	procGetRoleTextW = oleacc.NewProc("GetRoleTextW")
)

// lRole (DWORD), lpszRole (LPWSTR optional, out), cchRoleMax (DWORD)
r1, _, err := procGetRoleTextW.Call(
	uintptr(lRole),
	uintptr(lpszRole),
	uintptr(cchRoleMax),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetRoleTextW(
  lRole: DWORD;   // DWORD
  lpszRole: PWideChar;   // LPWSTR optional, out
  cchRoleMax: DWORD   // DWORD
): DWORD; stdcall;
  external 'OLEACC.dll' name 'GetRoleTextW';
result := DllCall("OLEACC\GetRoleTextW"
    , "UInt", lRole   ; DWORD
    , "Ptr", lpszRole   ; LPWSTR optional, out
    , "UInt", cchRoleMax   ; DWORD
    , "UInt")   ; return: DWORD
●GetRoleTextW(lRole, lpszRole, cchRoleMax) = DLL("OLEACC.dll", "dword GetRoleTextW(dword, char*, dword)")
# 呼び出し: GetRoleTextW(lRole, lpszRole, cchRoleMax)
# lRole : DWORD -> "dword"
# lpszRole : LPWSTR optional, out -> "char*"
# cchRoleMax : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "oleacc" fn GetRoleTextW(
    lRole: u32, // DWORD
    lpszRole: [*c]u16, // LPWSTR optional, out
    cchRoleMax: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetRoleTextW(
    lRole: uint32,  # DWORD
    lpszRole: ptr uint16,  # LPWSTR optional, out
    cchRoleMax: uint32  # DWORD
): uint32 {.importc: "GetRoleTextW", stdcall, dynlib: "OLEACC.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "oleacc");
extern(Windows)
uint GetRoleTextW(
    uint lRole,   // DWORD
    wchar* lpszRole,   // LPWSTR optional, out
    uint cchRoleMax   // DWORD
);
ccall((:GetRoleTextW, "OLEACC.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt16}, UInt32),
      lRole, lpszRole, cchRoleMax)
# lRole : DWORD -> UInt32
# lpszRole : LPWSTR optional, out -> Ptr{UInt16}
# cchRoleMax : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetRoleTextW(
    uint32_t lRole,
    uint16_t* lpszRole,
    uint32_t cchRoleMax);
]]
local oleacc = ffi.load("oleacc")
-- oleacc.GetRoleTextW(lRole, lpszRole, cchRoleMax)
-- lRole : DWORD
-- lpszRole : LPWSTR optional, out
-- cchRoleMax : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('OLEACC.dll');
const GetRoleTextW = lib.func('__stdcall', 'GetRoleTextW', 'uint32_t', ['uint32_t', 'uint16_t *', 'uint32_t']);
// GetRoleTextW(lRole, lpszRole, cchRoleMax)
// lRole : DWORD -> 'uint32_t'
// lpszRole : LPWSTR optional, out -> 'uint16_t *'
// cchRoleMax : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLEACC.dll", {
  GetRoleTextW: { parameters: ["u32", "buffer", "u32"], result: "u32" },
});
// lib.symbols.GetRoleTextW(lRole, lpszRole, cchRoleMax)
// lRole : DWORD -> "u32"
// lpszRole : LPWSTR optional, out -> "buffer"
// cchRoleMax : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetRoleTextW(
    uint32_t lRole,
    uint16_t* lpszRole,
    uint32_t cchRoleMax);
C, "OLEACC.dll");
// $ffi->GetRoleTextW(lRole, lpszRole, cchRoleMax);
// lRole : DWORD
// lpszRole : LPWSTR optional, out
// cchRoleMax : 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 Oleacc extends StdCallLibrary {
    Oleacc INSTANCE = Native.load("oleacc", Oleacc.class, W32APIOptions.UNICODE_OPTIONS);
    int GetRoleTextW(
        int lRole,   // DWORD
        char[] lpszRole,   // LPWSTR optional, out
        int cchRoleMax   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("oleacc")]
lib LibOLEACC
  fun GetRoleTextW = GetRoleTextW(
    lRole : UInt32,   # DWORD
    lpszRole : UInt16*,   # LPWSTR optional, out
    cchRoleMax : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetRoleTextWNative = Uint32 Function(Uint32, Pointer<Utf16>, Uint32);
typedef GetRoleTextWDart = int Function(int, Pointer<Utf16>, int);
final GetRoleTextW = DynamicLibrary.open('OLEACC.dll')
    .lookupFunction<GetRoleTextWNative, GetRoleTextWDart>('GetRoleTextW');
// lRole : DWORD -> Uint32
// lpszRole : LPWSTR optional, out -> Pointer<Utf16>
// cchRoleMax : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetRoleTextW(
  lRole: DWORD;   // DWORD
  lpszRole: PWideChar;   // LPWSTR optional, out
  cchRoleMax: DWORD   // DWORD
): DWORD; stdcall;
  external 'OLEACC.dll' name 'GetRoleTextW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetRoleTextW"
  c_GetRoleTextW :: Word32 -> CWString -> Word32 -> IO Word32
-- lRole : DWORD -> Word32
-- lpszRole : LPWSTR optional, out -> CWString
-- cchRoleMax : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getroletextw =
  foreign "GetRoleTextW"
    (uint32_t @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* lRole : DWORD -> uint32_t *)
(* lpszRole : LPWSTR optional, out -> (ptr uint16_t) *)
(* cchRoleMax : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleacc (t "OLEACC.dll"))
(cffi:use-foreign-library oleacc)

(cffi:defcfun ("GetRoleTextW" get-role-text-w :convention :stdcall) :uint32
  (l-role :uint32)   ; DWORD
  (lpsz-role :pointer)   ; LPWSTR optional, out
  (cch-role-max :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetRoleTextW = Win32::API::More->new('OLEACC',
    'DWORD GetRoleTextW(DWORD lRole, LPWSTR lpszRole, DWORD cchRoleMax)');
# my $ret = $GetRoleTextW->Call($lRole, $lpszRole, $cchRoleMax);
# lRole : DWORD -> DWORD
# lpszRole : LPWSTR optional, out -> LPWSTR
# cchRoleMax : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い