Win32 API 日本語リファレンス
ホームFoundation › SysFreeString

SysFreeString

関数
割り当てられたBSTR文字列を解放する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

// OLEAUT32.dll
#include <windows.h>

void SysFreeString(
    LPWSTR bstrString   // optional
);

パラメーター

名前方向説明
bstrStringLPWSTRinoptional以前に割り当てられた文字列。このパラメーターが NULL の場合、関数は単に処理を返します。

戻り値の型: void

公式ドキュメント

SysAllocString、SysAllocStringByteLen、SysReAllocString、SysAllocStringLen、または SysReAllocStringLen によって以前に割り当てられた文字列の割り当てを解放します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// OLEAUT32.dll
#include <windows.h>

void SysFreeString(
    LPWSTR bstrString   // optional
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern void SysFreeString(
    [MarshalAs(UnmanagedType.LPWStr)] string bstrString   // LPWSTR optional
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Sub SysFreeString(
    <MarshalAs(UnmanagedType.LPWStr)> bstrString As String   ' LPWSTR optional
)
End Sub
' bstrString : LPWSTR optional
Declare PtrSafe Sub SysFreeString Lib "oleaut32" ( _
    ByVal bstrString As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SysFreeString = ctypes.windll.oleaut32.SysFreeString
SysFreeString.restype = None
SysFreeString.argtypes = [
    wintypes.LPCWSTR,  # bstrString : LPWSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SysFreeString = Fiddle::Function.new(
  lib['SysFreeString'],
  [
    Fiddle::TYPE_VOIDP,  # bstrString : LPWSTR optional
  ],
  Fiddle::TYPE_VOID)
#[link(name = "oleaut32")]
extern "system" {
    fn SysFreeString(
        bstrString: *mut u16  // LPWSTR optional
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern void SysFreeString([MarshalAs(UnmanagedType.LPWStr)] string bstrString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SysFreeString' -Namespace Win32 -PassThru
# $api::SysFreeString(bstrString)
#uselib "OLEAUT32.dll"
#func global SysFreeString "SysFreeString" sptr
; SysFreeString bstrString
; bstrString : LPWSTR optional -> "sptr"
#uselib "OLEAUT32.dll"
#func global SysFreeString "SysFreeString" wstr
; SysFreeString bstrString
; bstrString : LPWSTR optional -> "wstr"
; void SysFreeString(LPWSTR bstrString)
#uselib "OLEAUT32.dll"
#func global SysFreeString "SysFreeString" wstr
; SysFreeString bstrString
; bstrString : LPWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSysFreeString = oleaut32.NewProc("SysFreeString")
)

// bstrString (LPWSTR optional)
r1, _, err := procSysFreeString.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(bstrString))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure SysFreeString(
  bstrString: PWideChar   // LPWSTR optional
); stdcall;
  external 'OLEAUT32.dll' name 'SysFreeString';
result := DllCall("OLEAUT32\SysFreeString"
    , "WStr", bstrString   ; LPWSTR optional
    , "Int")   ; return: void
●SysFreeString(bstrString) = DLL("OLEAUT32.dll", "int SysFreeString(char*)")
# 呼び出し: SysFreeString(bstrString)
# bstrString : LPWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "oleaut32" fn SysFreeString(
    bstrString: [*c]const u16 // LPWSTR optional
) callconv(std.os.windows.WINAPI) void;
proc SysFreeString(
    bstrString: WideCString  # LPWSTR optional
) {.importc: "SysFreeString", stdcall, dynlib: "OLEAUT32.dll".}
pragma(lib, "oleaut32");
extern(Windows)
void SysFreeString(
    const(wchar)* bstrString   // LPWSTR optional
);
ccall((:SysFreeString, "OLEAUT32.dll"), stdcall, Cvoid,
      (Cwstring,),
      bstrString)
# bstrString : LPWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void SysFreeString(
    const uint16_t* bstrString);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SysFreeString(bstrString)
-- bstrString : LPWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SysFreeString = lib.func('__stdcall', 'SysFreeString', 'void', ['str16']);
// SysFreeString(bstrString)
// bstrString : LPWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLEAUT32.dll", {
  SysFreeString: { parameters: ["buffer"], result: "void" },
});
// lib.symbols.SysFreeString(bstrString)
// bstrString : LPWSTR optional -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void SysFreeString(
    const uint16_t* bstrString);
C, "OLEAUT32.dll");
// $ffi->SysFreeString(bstrString);
// bstrString : LPWSTR optional
// 構造体/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 Oleaut32 extends StdCallLibrary {
    Oleaut32 INSTANCE = Native.load("oleaut32", Oleaut32.class);
    void SysFreeString(
        WString bstrString   // LPWSTR optional
    );
}
@[Link("oleaut32")]
lib LibOLEAUT32
  fun SysFreeString = SysFreeString(
    bstrString : UInt16*   # LPWSTR optional
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SysFreeStringNative = Void Function(Pointer<Utf16>);
typedef SysFreeStringDart = void Function(Pointer<Utf16>);
final SysFreeString = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SysFreeStringNative, SysFreeStringDart>('SysFreeString');
// bstrString : LPWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure SysFreeString(
  bstrString: PWideChar   // LPWSTR optional
); stdcall;
  external 'OLEAUT32.dll' name 'SysFreeString';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SysFreeString"
  c_SysFreeString :: CWString -> IO ()
-- bstrString : LPWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sysfreestring =
  foreign "SysFreeString"
    ((ptr uint16_t) @-> returning void)
(* bstrString : LPWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("SysFreeString" sys-free-string :convention :stdcall) :void
  (bstr-string (:string :encoding :utf-16le)))   ; LPWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SysFreeString = Win32::API::More->new('OLEAUT32',
    'void SysFreeString(LPCWSTR bstrString)');
# my $ret = $SysFreeString->Call($bstrString);
# bstrString : LPWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。