ホーム › Foundation › SysAddRefString
SysAddRefString
関数BSTRの参照カウントを増加させる。
シグネチャ
// OLEAUT32.dll
#include <windows.h>
HRESULT SysAddRefString(
LPWSTR bstrString
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| bstrString | LPWSTR | in | ピン留め参照カウントを増やす対象の文字列。このカウントが 0 より大きい間、その文字列のメモリは SysFreeString 関数の呼び出しによって解放されることが防止されます。 |
戻り値の型: HRESULT
公式ドキュメント
指定された文字列のピン留め参照カウントを 1 増やします。
戻り値
この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
BSTR データ型を持つ文字列には、従来から参照カウントがありませんでした。これらの文字列の既存の使用方法はすべて、変更なしで引き続き動作します。SysAddRefString および SysReleaseString 関数は、参照カウントを使用して文字列をメモリにピン留めする機能を追加します。これは、信頼できないスクリプトから、メソッドが戻る前にスクリプトがメモリを解放することを想定していない可能性のある IDispatch メソッドを呼び出す前にピン留めを行うためのものであり、これによってスクリプトがそのメソッドのコードに解放済みのメモリへアクセスさせることを防ぎます。そのようなメソッドが安全に戻った後は、SysReleaseString を呼び出してピン留め参照を解放する必要があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLEAUT32.dll
#include <windows.h>
HRESULT SysAddRefString(
LPWSTR bstrString
);[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SysAddRefString(
[MarshalAs(UnmanagedType.LPWStr)] string bstrString // LPWSTR
);<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SysAddRefString(
<MarshalAs(UnmanagedType.LPWStr)> bstrString As String ' LPWSTR
) As Integer
End Function' bstrString : LPWSTR
Declare PtrSafe Function SysAddRefString Lib "oleaut32" ( _
ByVal bstrString As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SysAddRefString = ctypes.windll.oleaut32.SysAddRefString
SysAddRefString.restype = ctypes.c_int
SysAddRefString.argtypes = [
wintypes.LPCWSTR, # bstrString : LPWSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLEAUT32.dll')
SysAddRefString = Fiddle::Function.new(
lib['SysAddRefString'],
[
Fiddle::TYPE_VOIDP, # bstrString : LPWSTR
],
Fiddle::TYPE_INT)#[link(name = "oleaut32")]
extern "system" {
fn SysAddRefString(
bstrString: *mut u16 // LPWSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int SysAddRefString([MarshalAs(UnmanagedType.LPWStr)] string bstrString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SysAddRefString' -Namespace Win32 -PassThru
# $api::SysAddRefString(bstrString)#uselib "OLEAUT32.dll"
#func global SysAddRefString "SysAddRefString" sptr
; SysAddRefString bstrString ; 戻り値は stat
; bstrString : LPWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLEAUT32.dll"
#cfunc global SysAddRefString "SysAddRefString" wstr
; res = SysAddRefString(bstrString)
; bstrString : LPWSTR -> "wstr"; HRESULT SysAddRefString(LPWSTR bstrString)
#uselib "OLEAUT32.dll"
#cfunc global SysAddRefString "SysAddRefString" wstr
; res = SysAddRefString(bstrString)
; bstrString : LPWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
procSysAddRefString = oleaut32.NewProc("SysAddRefString")
)
// bstrString (LPWSTR)
r1, _, err := procSysAddRefString.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(bstrString))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SysAddRefString(
bstrString: PWideChar // LPWSTR
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SysAddRefString';result := DllCall("OLEAUT32\SysAddRefString"
, "WStr", bstrString ; LPWSTR
, "Int") ; return: HRESULT●SysAddRefString(bstrString) = DLL("OLEAUT32.dll", "int SysAddRefString(char*)")
# 呼び出し: SysAddRefString(bstrString)
# bstrString : LPWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "oleaut32" fn SysAddRefString(
bstrString: [*c]const u16 // LPWSTR
) callconv(std.os.windows.WINAPI) i32;proc SysAddRefString(
bstrString: WideCString # LPWSTR
): int32 {.importc: "SysAddRefString", stdcall, dynlib: "OLEAUT32.dll".}pragma(lib, "oleaut32");
extern(Windows)
int SysAddRefString(
const(wchar)* bstrString // LPWSTR
);ccall((:SysAddRefString, "OLEAUT32.dll"), stdcall, Int32,
(Cwstring,),
bstrString)
# bstrString : LPWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SysAddRefString(
const uint16_t* bstrString);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SysAddRefString(bstrString)
-- bstrString : LPWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SysAddRefString = lib.func('__stdcall', 'SysAddRefString', 'int32_t', ['str16']);
// SysAddRefString(bstrString)
// bstrString : LPWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLEAUT32.dll", {
SysAddRefString: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.SysAddRefString(bstrString)
// bstrString : LPWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SysAddRefString(
const uint16_t* bstrString);
C, "OLEAUT32.dll");
// $ffi->SysAddRefString(bstrString);
// bstrString : LPWSTR
// 構造体/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);
int SysAddRefString(
WString bstrString // LPWSTR
);
}@[Link("oleaut32")]
lib LibOLEAUT32
fun SysAddRefString = SysAddRefString(
bstrString : UInt16* # LPWSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SysAddRefStringNative = Int32 Function(Pointer<Utf16>);
typedef SysAddRefStringDart = int Function(Pointer<Utf16>);
final SysAddRefString = DynamicLibrary.open('OLEAUT32.dll')
.lookupFunction<SysAddRefStringNative, SysAddRefStringDart>('SysAddRefString');
// bstrString : LPWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SysAddRefString(
bstrString: PWideChar // LPWSTR
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SysAddRefString';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SysAddRefString"
c_SysAddRefString :: CWString -> IO Int32
-- bstrString : LPWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let sysaddrefstring =
foreign "SysAddRefString"
((ptr uint16_t) @-> returning int32_t)
(* bstrString : LPWSTR -> (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 ("SysAddRefString" sys-add-ref-string :convention :stdcall) :int32
(bstr-string (:string :encoding :utf-16le))) ; LPWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SysAddRefString = Win32::API::More->new('OLEAUT32',
'int SysAddRefString(LPCWSTR bstrString)');
# my $ret = $SysAddRefString->Call($bstrString);
# bstrString : LPWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f SysReleaseString — BSTRの参照カウントを減らし不要なら解放する。