Win32 API 日本語リファレンス
ホームSystem.Rpc › RpcStringFreeW

RpcStringFreeW

関数
RPCが割り当てた文字列を解放する(Unicode版)。
DLLRPCRT4.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

RPC_STATUS RpcStringFreeW(
    LPWSTR* String
);

パラメーター

名前方向説明
StringLPWSTR*inoutRPCランタイムが割り当てた文字列(ワイド)を解放する変数のアドレス。

戻り値の型: RPC_STATUS

各言語での呼び出し定義

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

RPC_STATUS RpcStringFreeW(
    LPWSTR* String
);
[DllImport("RPCRT4.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int RpcStringFreeW(
    IntPtr String   // LPWSTR* in/out
);
<DllImport("RPCRT4.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RpcStringFreeW(
    [String] As IntPtr   ' LPWSTR* in/out
) As Integer
End Function
' String : LPWSTR* in/out
Declare PtrSafe Function RpcStringFreeW Lib "rpcrt4" ( _
    ByVal String 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

RpcStringFreeW = ctypes.windll.rpcrt4.RpcStringFreeW
RpcStringFreeW.restype = ctypes.c_int
RpcStringFreeW.argtypes = [
    ctypes.c_void_p,  # String : LPWSTR* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
	procRpcStringFreeW = rpcrt4.NewProc("RpcStringFreeW")
)

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

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

typedef RpcStringFreeWNative = Int32 Function(Pointer<Pointer<Utf16>>);
typedef RpcStringFreeWDart = int Function(Pointer<Pointer<Utf16>>);
final RpcStringFreeW = DynamicLibrary.open('RPCRT4.dll')
    .lookupFunction<RpcStringFreeWNative, RpcStringFreeWDart>('RpcStringFreeW');
// String : LPWSTR* in/out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RpcStringFreeW(
  String: PPWideChar   // LPWSTR* in/out
): Integer; stdcall;
  external 'RPCRT4.dll' name 'RpcStringFreeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RpcStringFreeW"
  c_RpcStringFreeW :: Ptr CWString -> IO Int32
-- String : LPWSTR* in/out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rpcstringfreew =
  foreign "RpcStringFreeW"
    ((ptr (ptr uint16_t)) @-> returning int32_t)
(* String : LPWSTR* in/out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rpcrt4 (t "RPCRT4.dll"))
(cffi:use-foreign-library rpcrt4)

(cffi:defcfun ("RpcStringFreeW" rpc-string-free-w :convention :stdcall) :int32
  (string :pointer))   ; LPWSTR* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RpcStringFreeW = Win32::API::More->new('RPCRT4',
    'int RpcStringFreeW(LPVOID String)');
# my $ret = $RpcStringFreeW->Call($String);
# String : LPWSTR* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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