Win32 API 日本語リファレンス
ホームSecurity.Authentication.Identity › TranslateNameW

TranslateNameW

関数
ディレクトリアカウント名を別の名前形式に変換する(Unicode版)。
DLLSECUR32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOLEAN TranslateNameW(
    LPCWSTR lpAccountName,
    EXTENDED_NAME_FORMAT AccountNameFormat,
    EXTENDED_NAME_FORMAT DesiredNameFormat,
    LPWSTR lpTranslatedName,   // optional
    DWORD* nSize
);

パラメーター

名前方向説明
lpAccountNameLPCWSTRin変換元のアカウント名を指すUnicode文字列。
AccountNameFormatEXTENDED_NAME_FORMATinlpAccountNameの現在の形式を示すEXTENDED_NAME_FORMAT列挙値。
DesiredNameFormatEXTENDED_NAME_FORMATin変換後に得たい名前形式を示すEXTENDED_NAME_FORMAT列挙値。
lpTranslatedNameLPWSTRoutoptional変換結果の名前を受け取るUnicode文字列バッファへのポインタ。
nSizeDWORD*inout入力時はバッファ文字数、出力時は格納文字数を示すDWORDへのポインタ。

戻り値の型: BOOLEAN

各言語での呼び出し定義

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

BOOLEAN TranslateNameW(
    LPCWSTR lpAccountName,
    EXTENDED_NAME_FORMAT AccountNameFormat,
    EXTENDED_NAME_FORMAT DesiredNameFormat,
    LPWSTR lpTranslatedName,   // optional
    DWORD* nSize
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("SECUR32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool TranslateNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpAccountName,   // LPCWSTR
    int AccountNameFormat,   // EXTENDED_NAME_FORMAT
    int DesiredNameFormat,   // EXTENDED_NAME_FORMAT
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpTranslatedName,   // LPWSTR optional, out
    ref uint nSize   // DWORD* in/out
);
<DllImport("SECUR32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TranslateNameW(
    <MarshalAs(UnmanagedType.LPWStr)> lpAccountName As String,   ' LPCWSTR
    AccountNameFormat As Integer,   ' EXTENDED_NAME_FORMAT
    DesiredNameFormat As Integer,   ' EXTENDED_NAME_FORMAT
    <MarshalAs(UnmanagedType.LPWStr)> lpTranslatedName As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef nSize As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' lpAccountName : LPCWSTR
' AccountNameFormat : EXTENDED_NAME_FORMAT
' DesiredNameFormat : EXTENDED_NAME_FORMAT
' lpTranslatedName : LPWSTR optional, out
' nSize : DWORD* in/out
Declare PtrSafe Function TranslateNameW Lib "secur32" ( _
    ByVal lpAccountName As LongPtr, _
    ByVal AccountNameFormat As Long, _
    ByVal DesiredNameFormat As Long, _
    ByVal lpTranslatedName As LongPtr, _
    ByRef nSize As Long) As Byte
' 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

TranslateNameW = ctypes.windll.secur32.TranslateNameW
TranslateNameW.restype = wintypes.BOOLEAN
TranslateNameW.argtypes = [
    wintypes.LPCWSTR,  # lpAccountName : LPCWSTR
    ctypes.c_int,  # AccountNameFormat : EXTENDED_NAME_FORMAT
    ctypes.c_int,  # DesiredNameFormat : EXTENDED_NAME_FORMAT
    wintypes.LPWSTR,  # lpTranslatedName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # nSize : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	secur32 = windows.NewLazySystemDLL("SECUR32.dll")
	procTranslateNameW = secur32.NewProc("TranslateNameW")
)

// lpAccountName (LPCWSTR), AccountNameFormat (EXTENDED_NAME_FORMAT), DesiredNameFormat (EXTENDED_NAME_FORMAT), lpTranslatedName (LPWSTR optional, out), nSize (DWORD* in/out)
r1, _, err := procTranslateNameW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpAccountName))),
	uintptr(AccountNameFormat),
	uintptr(DesiredNameFormat),
	uintptr(lpTranslatedName),
	uintptr(nSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOLEAN
function TranslateNameW(
  lpAccountName: PWideChar;   // LPCWSTR
  AccountNameFormat: Integer;   // EXTENDED_NAME_FORMAT
  DesiredNameFormat: Integer;   // EXTENDED_NAME_FORMAT
  lpTranslatedName: PWideChar;   // LPWSTR optional, out
  nSize: Pointer   // DWORD* in/out
): ByteBool; stdcall;
  external 'SECUR32.dll' name 'TranslateNameW';
result := DllCall("SECUR32\TranslateNameW"
    , "WStr", lpAccountName   ; LPCWSTR
    , "Int", AccountNameFormat   ; EXTENDED_NAME_FORMAT
    , "Int", DesiredNameFormat   ; EXTENDED_NAME_FORMAT
    , "Ptr", lpTranslatedName   ; LPWSTR optional, out
    , "Ptr", nSize   ; DWORD* in/out
    , "Char")   ; return: BOOLEAN
●TranslateNameW(lpAccountName, AccountNameFormat, DesiredNameFormat, lpTranslatedName, nSize) = DLL("SECUR32.dll", "byte TranslateNameW(char*, int, int, char*, void*)")
# 呼び出し: TranslateNameW(lpAccountName, AccountNameFormat, DesiredNameFormat, lpTranslatedName, nSize)
# lpAccountName : LPCWSTR -> "char*"
# AccountNameFormat : EXTENDED_NAME_FORMAT -> "int"
# DesiredNameFormat : EXTENDED_NAME_FORMAT -> "int"
# lpTranslatedName : LPWSTR optional, out -> "char*"
# nSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

typedef TranslateNameWNative = Uint8 Function(Pointer<Utf16>, Int32, Int32, Pointer<Utf16>, Pointer<Uint32>);
typedef TranslateNameWDart = int Function(Pointer<Utf16>, int, int, Pointer<Utf16>, Pointer<Uint32>);
final TranslateNameW = DynamicLibrary.open('SECUR32.dll')
    .lookupFunction<TranslateNameWNative, TranslateNameWDart>('TranslateNameW');
// lpAccountName : LPCWSTR -> Pointer<Utf16>
// AccountNameFormat : EXTENDED_NAME_FORMAT -> Int32
// DesiredNameFormat : EXTENDED_NAME_FORMAT -> Int32
// lpTranslatedName : LPWSTR optional, out -> Pointer<Utf16>
// nSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TranslateNameW(
  lpAccountName: PWideChar;   // LPCWSTR
  AccountNameFormat: Integer;   // EXTENDED_NAME_FORMAT
  DesiredNameFormat: Integer;   // EXTENDED_NAME_FORMAT
  lpTranslatedName: PWideChar;   // LPWSTR optional, out
  nSize: Pointer   // DWORD* in/out
): ByteBool; stdcall;
  external 'SECUR32.dll' name 'TranslateNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TranslateNameW"
  c_TranslateNameW :: CWString -> Int32 -> Int32 -> CWString -> Ptr Word32 -> IO Word8
-- lpAccountName : LPCWSTR -> CWString
-- AccountNameFormat : EXTENDED_NAME_FORMAT -> Int32
-- DesiredNameFormat : EXTENDED_NAME_FORMAT -> Int32
-- lpTranslatedName : LPWSTR optional, out -> CWString
-- nSize : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let translatenamew =
  foreign "TranslateNameW"
    ((ptr uint16_t) @-> int32_t @-> int32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint8_t)
(* lpAccountName : LPCWSTR -> (ptr uint16_t) *)
(* AccountNameFormat : EXTENDED_NAME_FORMAT -> int32_t *)
(* DesiredNameFormat : EXTENDED_NAME_FORMAT -> int32_t *)
(* lpTranslatedName : LPWSTR optional, out -> (ptr uint16_t) *)
(* nSize : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library secur32 (t "SECUR32.dll"))
(cffi:use-foreign-library secur32)

(cffi:defcfun ("TranslateNameW" translate-name-w :convention :stdcall) :uint8
  (lp-account-name (:string :encoding :utf-16le))   ; LPCWSTR
  (account-name-format :int32)   ; EXTENDED_NAME_FORMAT
  (desired-name-format :int32)   ; EXTENDED_NAME_FORMAT
  (lp-translated-name :pointer)   ; LPWSTR optional, out
  (n-size :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TranslateNameW = Win32::API::More->new('SECUR32',
    'BYTE TranslateNameW(LPCWSTR lpAccountName, int AccountNameFormat, int DesiredNameFormat, LPWSTR lpTranslatedName, LPVOID nSize)');
# my $ret = $TranslateNameW->Call($lpAccountName, $AccountNameFormat, $DesiredNameFormat, $lpTranslatedName, $nSize);
# lpAccountName : LPCWSTR -> LPCWSTR
# AccountNameFormat : EXTENDED_NAME_FORMAT -> int
# DesiredNameFormat : EXTENDED_NAME_FORMAT -> int
# lpTranslatedName : LPWSTR optional, out -> LPWSTR
# nSize : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型