Win32 API 日本語リファレンス
ホームNetworkManagement.Rras › RasGetCustomAuthDataW

RasGetCustomAuthDataW

関数
電話帳エントリのカスタム認証データを取得する(Unicode版)。
DLLRASAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD RasGetCustomAuthDataW(
    LPCWSTR pszPhonebook,   // optional
    LPCWSTR pszEntry,
    BYTE* pbCustomAuthData,   // optional
    DWORD* pdwSizeofCustomAuthData
);

パラメーター

名前方向説明
pszPhonebookLPCWSTRinoptional電話帳ファイルのフルパス文字列。NULL指定で既定の電話帳を使用する。
pszEntryLPCWSTRin対象エントリ名の文字列。
pbCustomAuthDataBYTE*outoptional取得したカスタム認証データを受け取るバッファへのポインタ。NULL指定でサイズ問い合わせを行える。
pdwSizeofCustomAuthDataDWORD*inoutpbCustomAuthDataバッファのサイズ(バイト)を保持する入出力変数へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD RasGetCustomAuthDataW(
    LPCWSTR pszPhonebook,   // optional
    LPCWSTR pszEntry,
    BYTE* pbCustomAuthData,   // optional
    DWORD* pdwSizeofCustomAuthData
);
[DllImport("RASAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RasGetCustomAuthDataW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPhonebook,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszEntry,   // LPCWSTR
    IntPtr pbCustomAuthData,   // BYTE* optional, out
    ref uint pdwSizeofCustomAuthData   // DWORD* in/out
);
<DllImport("RASAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RasGetCustomAuthDataW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPhonebook As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pszEntry As String,   ' LPCWSTR
    pbCustomAuthData As IntPtr,   ' BYTE* optional, out
    ByRef pdwSizeofCustomAuthData As UInteger   ' DWORD* in/out
) As UInteger
End Function
' pszPhonebook : LPCWSTR optional
' pszEntry : LPCWSTR
' pbCustomAuthData : BYTE* optional, out
' pdwSizeofCustomAuthData : DWORD* in/out
Declare PtrSafe Function RasGetCustomAuthDataW Lib "rasapi32" ( _
    ByVal pszPhonebook As LongPtr, _
    ByVal pszEntry As LongPtr, _
    ByVal pbCustomAuthData As LongPtr, _
    ByRef pdwSizeofCustomAuthData 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

RasGetCustomAuthDataW = ctypes.windll.rasapi32.RasGetCustomAuthDataW
RasGetCustomAuthDataW.restype = wintypes.DWORD
RasGetCustomAuthDataW.argtypes = [
    wintypes.LPCWSTR,  # pszPhonebook : LPCWSTR optional
    wintypes.LPCWSTR,  # pszEntry : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbCustomAuthData : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwSizeofCustomAuthData : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rasapi32 = windows.NewLazySystemDLL("RASAPI32.dll")
	procRasGetCustomAuthDataW = rasapi32.NewProc("RasGetCustomAuthDataW")
)

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

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

typedef RasGetCustomAuthDataWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
typedef RasGetCustomAuthDataWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
final RasGetCustomAuthDataW = DynamicLibrary.open('RASAPI32.dll')
    .lookupFunction<RasGetCustomAuthDataWNative, RasGetCustomAuthDataWDart>('RasGetCustomAuthDataW');
// pszPhonebook : LPCWSTR optional -> Pointer<Utf16>
// pszEntry : LPCWSTR -> Pointer<Utf16>
// pbCustomAuthData : BYTE* optional, out -> Pointer<Uint8>
// pdwSizeofCustomAuthData : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RasGetCustomAuthDataW(
  pszPhonebook: PWideChar;   // LPCWSTR optional
  pszEntry: PWideChar;   // LPCWSTR
  pbCustomAuthData: Pointer;   // BYTE* optional, out
  pdwSizeofCustomAuthData: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'RASAPI32.dll' name 'RasGetCustomAuthDataW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RasGetCustomAuthDataW"
  c_RasGetCustomAuthDataW :: CWString -> CWString -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- pszPhonebook : LPCWSTR optional -> CWString
-- pszEntry : LPCWSTR -> CWString
-- pbCustomAuthData : BYTE* optional, out -> Ptr Word8
-- pdwSizeofCustomAuthData : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rasgetcustomauthdataw =
  foreign "RasGetCustomAuthDataW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* pszPhonebook : LPCWSTR optional -> (ptr uint16_t) *)
(* pszEntry : LPCWSTR -> (ptr uint16_t) *)
(* pbCustomAuthData : BYTE* optional, out -> (ptr uint8_t) *)
(* pdwSizeofCustomAuthData : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rasapi32 (t "RASAPI32.dll"))
(cffi:use-foreign-library rasapi32)

(cffi:defcfun ("RasGetCustomAuthDataW" ras-get-custom-auth-data-w :convention :stdcall) :uint32
  (psz-phonebook (:string :encoding :utf-16le))   ; LPCWSTR optional
  (psz-entry (:string :encoding :utf-16le))   ; LPCWSTR
  (pb-custom-auth-data :pointer)   ; BYTE* optional, out
  (pdw-sizeof-custom-auth-data :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RasGetCustomAuthDataW = Win32::API::More->new('RASAPI32',
    'DWORD RasGetCustomAuthDataW(LPCWSTR pszPhonebook, LPCWSTR pszEntry, LPVOID pbCustomAuthData, LPVOID pdwSizeofCustomAuthData)');
# my $ret = $RasGetCustomAuthDataW->Call($pszPhonebook, $pszEntry, $pbCustomAuthData, $pdwSizeofCustomAuthData);
# pszPhonebook : LPCWSTR optional -> LPCWSTR
# pszEntry : LPCWSTR -> LPCWSTR
# pbCustomAuthData : BYTE* optional, out -> LPVOID
# pdwSizeofCustomAuthData : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い