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

RasRenameEntryW

関数
RAS電話帳エントリの名前を変更する(Unicode版)。
DLLRASAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD RasRenameEntryW(
    LPCWSTR param0,   // optional
    LPCWSTR param1,
    LPCWSTR param2
);

パラメーター

名前方向説明
param0LPCWSTRinoptional電話帳ファイルのフルパス文字列。NULL指定で既定の電話帳を使用する。
param1LPCWSTRin変更前の既存エントリ名の文字列。
param2LPCWSTRin変更後の新しいエントリ名の文字列。電話帳内で一意である必要がある。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD RasRenameEntryW(
    LPCWSTR param0,   // optional
    LPCWSTR param1,
    LPCWSTR param2
);
[DllImport("RASAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RasRenameEntryW(
    [MarshalAs(UnmanagedType.LPWStr)] string param0,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string param1,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string param2   // LPCWSTR
);
<DllImport("RASAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RasRenameEntryW(
    <MarshalAs(UnmanagedType.LPWStr)> param0 As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> param1 As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> param2 As String   ' LPCWSTR
) As UInteger
End Function
' param0 : LPCWSTR optional
' param1 : LPCWSTR
' param2 : LPCWSTR
Declare PtrSafe Function RasRenameEntryW Lib "rasapi32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As LongPtr, _
    ByVal param2 As LongPtr) 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

RasRenameEntryW = ctypes.windll.rasapi32.RasRenameEntryW
RasRenameEntryW.restype = wintypes.DWORD
RasRenameEntryW.argtypes = [
    wintypes.LPCWSTR,  # param0 : LPCWSTR optional
    wintypes.LPCWSTR,  # param1 : LPCWSTR
    wintypes.LPCWSTR,  # param2 : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RASAPI32.dll')
RasRenameEntryW = Fiddle::Function.new(
  lib['RasRenameEntryW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # param1 : LPCWSTR
    Fiddle::TYPE_VOIDP,  # param2 : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "rasapi32")]
extern "system" {
    fn RasRenameEntryW(
        param0: *const u16,  // LPCWSTR optional
        param1: *const u16,  // LPCWSTR
        param2: *const u16  // LPCWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RASAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint RasRenameEntryW([MarshalAs(UnmanagedType.LPWStr)] string param0, [MarshalAs(UnmanagedType.LPWStr)] string param1, [MarshalAs(UnmanagedType.LPWStr)] string param2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASAPI32_RasRenameEntryW' -Namespace Win32 -PassThru
# $api::RasRenameEntryW(param0, param1, param2)
#uselib "RASAPI32.dll"
#func global RasRenameEntryW "RasRenameEntryW" wptr, wptr, wptr
; RasRenameEntryW param0, param1, param2   ; 戻り値は stat
; param0 : LPCWSTR optional -> "wptr"
; param1 : LPCWSTR -> "wptr"
; param2 : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RASAPI32.dll"
#cfunc global RasRenameEntryW "RasRenameEntryW" wstr, wstr, wstr
; res = RasRenameEntryW(param0, param1, param2)
; param0 : LPCWSTR optional -> "wstr"
; param1 : LPCWSTR -> "wstr"
; param2 : LPCWSTR -> "wstr"
; DWORD RasRenameEntryW(LPCWSTR param0, LPCWSTR param1, LPCWSTR param2)
#uselib "RASAPI32.dll"
#cfunc global RasRenameEntryW "RasRenameEntryW" wstr, wstr, wstr
; res = RasRenameEntryW(param0, param1, param2)
; param0 : LPCWSTR optional -> "wstr"
; param1 : LPCWSTR -> "wstr"
; param2 : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rasapi32 = windows.NewLazySystemDLL("RASAPI32.dll")
	procRasRenameEntryW = rasapi32.NewProc("RasRenameEntryW")
)

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

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

typedef RasRenameEntryWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
typedef RasRenameEntryWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
final RasRenameEntryW = DynamicLibrary.open('RASAPI32.dll')
    .lookupFunction<RasRenameEntryWNative, RasRenameEntryWDart>('RasRenameEntryW');
// param0 : LPCWSTR optional -> Pointer<Utf16>
// param1 : LPCWSTR -> Pointer<Utf16>
// param2 : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RasRenameEntryW(
  param0: PWideChar;   // LPCWSTR optional
  param1: PWideChar;   // LPCWSTR
  param2: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'RASAPI32.dll' name 'RasRenameEntryW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RasRenameEntryW"
  c_RasRenameEntryW :: CWString -> CWString -> CWString -> IO Word32
-- param0 : LPCWSTR optional -> CWString
-- param1 : LPCWSTR -> CWString
-- param2 : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rasrenameentryw =
  foreign "RasRenameEntryW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* param0 : LPCWSTR optional -> (ptr uint16_t) *)
(* param1 : LPCWSTR -> (ptr uint16_t) *)
(* param2 : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rasapi32 (t "RASAPI32.dll"))
(cffi:use-foreign-library rasapi32)

(cffi:defcfun ("RasRenameEntryW" ras-rename-entry-w :convention :stdcall) :uint32
  (param0 (:string :encoding :utf-16le))   ; LPCWSTR optional
  (param1 (:string :encoding :utf-16le))   ; LPCWSTR
  (param2 (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RasRenameEntryW = Win32::API::More->new('RASAPI32',
    'DWORD RasRenameEntryW(LPCWSTR param0, LPCWSTR param1, LPCWSTR param2)');
# my $ret = $RasRenameEntryW->Call($param0, $param1, $param2);
# param0 : LPCWSTR optional -> LPCWSTR
# param1 : LPCWSTR -> LPCWSTR
# param2 : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い