ホーム › System.Ole › SafeArrayUnlock
SafeArrayUnlock
関数SAFEARRAYのロックを解除する。
シグネチャ
// OLEAUT32.dll
#include <windows.h>
HRESULT SafeArrayUnlock(
SAFEARRAY* psa
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| psa | SAFEARRAY* | in | SafeArrayCreate によって作成された配列記述子。 |
戻り値の型: HRESULT
公式ドキュメント
配列のロックカウントをデクリメントし、配列を解放またはサイズ変更できるようにします。
戻り値
この関数は次のいずれかの値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| 成功しました。 | |
| 引数 psa が無効です。 | |
| 配列のロックを解除できませんでした。 |
解説(Remarks)
この関数は、配列内のデータへのアクセスが完了した後に呼び出します。
スレッドセーフティ
SAFEARRAY データ型のすべてのパブリックな静的メンバーはスレッドセーフです。インスタンスメンバーはスレッドセーフであることが保証されません。
たとえば、SafeArrayLock 関数と SafeArrayUnlock 関数を使用するアプリケーションを考えてみます。これらの関数が同一の SAFEARRAY データ型インスタンスに対して異なるスレッドから同時に呼び出されると、一貫性のないロックカウントが生じる可能性があります。これにより、最終的に SafeArrayUnlock 関数が E_UNEXPECTED を返す原因となります。独自の同期コードを用意することで、これを防ぐことができます。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SafeArrayUnlock(
SAFEARRAY* psa
);[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayUnlock(
IntPtr psa // SAFEARRAY*
);<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayUnlock(
psa As IntPtr ' SAFEARRAY*
) As Integer
End Function' psa : SAFEARRAY*
Declare PtrSafe Function SafeArrayUnlock Lib "oleaut32" ( _
ByVal psa As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SafeArrayUnlock = ctypes.windll.oleaut32.SafeArrayUnlock
SafeArrayUnlock.restype = ctypes.c_int
SafeArrayUnlock.argtypes = [
ctypes.c_void_p, # psa : SAFEARRAY*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayUnlock = Fiddle::Function.new(
lib['SafeArrayUnlock'],
[
Fiddle::TYPE_VOIDP, # psa : SAFEARRAY*
],
Fiddle::TYPE_INT)#[link(name = "oleaut32")]
extern "system" {
fn SafeArrayUnlock(
psa: *mut SAFEARRAY // SAFEARRAY*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int SafeArrayUnlock(IntPtr psa);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayUnlock' -Namespace Win32 -PassThru
# $api::SafeArrayUnlock(psa)#uselib "OLEAUT32.dll"
#func global SafeArrayUnlock "SafeArrayUnlock" sptr
; SafeArrayUnlock varptr(psa) ; 戻り値は stat
; psa : SAFEARRAY* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "OLEAUT32.dll" #cfunc global SafeArrayUnlock "SafeArrayUnlock" var ; res = SafeArrayUnlock(psa) ; psa : SAFEARRAY* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll" #cfunc global SafeArrayUnlock "SafeArrayUnlock" sptr ; res = SafeArrayUnlock(varptr(psa)) ; psa : SAFEARRAY* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT SafeArrayUnlock(SAFEARRAY* psa) #uselib "OLEAUT32.dll" #cfunc global SafeArrayUnlock "SafeArrayUnlock" var ; res = SafeArrayUnlock(psa) ; psa : SAFEARRAY* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT SafeArrayUnlock(SAFEARRAY* psa) #uselib "OLEAUT32.dll" #cfunc global SafeArrayUnlock "SafeArrayUnlock" intptr ; res = SafeArrayUnlock(varptr(psa)) ; psa : SAFEARRAY* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
procSafeArrayUnlock = oleaut32.NewProc("SafeArrayUnlock")
)
// psa (SAFEARRAY*)
r1, _, err := procSafeArrayUnlock.Call(
uintptr(psa),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SafeArrayUnlock(
psa: Pointer // SAFEARRAY*
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SafeArrayUnlock';result := DllCall("OLEAUT32\SafeArrayUnlock"
, "Ptr", psa ; SAFEARRAY*
, "Int") ; return: HRESULT●SafeArrayUnlock(psa) = DLL("OLEAUT32.dll", "int SafeArrayUnlock(void*)")
# 呼び出し: SafeArrayUnlock(psa)
# psa : SAFEARRAY* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "oleaut32" fn SafeArrayUnlock(
psa: [*c]SAFEARRAY // SAFEARRAY*
) callconv(std.os.windows.WINAPI) i32;proc SafeArrayUnlock(
psa: ptr SAFEARRAY # SAFEARRAY*
): int32 {.importc: "SafeArrayUnlock", stdcall, dynlib: "OLEAUT32.dll".}pragma(lib, "oleaut32");
extern(Windows)
int SafeArrayUnlock(
SAFEARRAY* psa // SAFEARRAY*
);ccall((:SafeArrayUnlock, "OLEAUT32.dll"), stdcall, Int32,
(Ptr{SAFEARRAY},),
psa)
# psa : SAFEARRAY* -> Ptr{SAFEARRAY}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SafeArrayUnlock(
void* psa);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SafeArrayUnlock(psa)
-- psa : SAFEARRAY*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SafeArrayUnlock = lib.func('__stdcall', 'SafeArrayUnlock', 'int32_t', ['void *']);
// SafeArrayUnlock(psa)
// psa : SAFEARRAY* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLEAUT32.dll", {
SafeArrayUnlock: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.SafeArrayUnlock(psa)
// psa : SAFEARRAY* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SafeArrayUnlock(
void* psa);
C, "OLEAUT32.dll");
// $ffi->SafeArrayUnlock(psa);
// psa : SAFEARRAY*
// 構造体/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 SafeArrayUnlock(
Pointer psa // SAFEARRAY*
);
}@[Link("oleaut32")]
lib LibOLEAUT32
fun SafeArrayUnlock = SafeArrayUnlock(
psa : SAFEARRAY* # SAFEARRAY*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SafeArrayUnlockNative = Int32 Function(Pointer<Void>);
typedef SafeArrayUnlockDart = int Function(Pointer<Void>);
final SafeArrayUnlock = DynamicLibrary.open('OLEAUT32.dll')
.lookupFunction<SafeArrayUnlockNative, SafeArrayUnlockDart>('SafeArrayUnlock');
// psa : SAFEARRAY* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SafeArrayUnlock(
psa: Pointer // SAFEARRAY*
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SafeArrayUnlock';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SafeArrayUnlock"
c_SafeArrayUnlock :: Ptr () -> IO Int32
-- psa : SAFEARRAY* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let safearrayunlock =
foreign "SafeArrayUnlock"
((ptr void) @-> returning int32_t)
(* psa : SAFEARRAY* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)
(cffi:defcfun ("SafeArrayUnlock" safe-array-unlock :convention :stdcall) :int32
(psa :pointer)) ; SAFEARRAY*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SafeArrayUnlock = Win32::API::More->new('OLEAUT32',
'int SafeArrayUnlock(LPVOID psa)');
# my $ret = $SafeArrayUnlock->Call($psa);
# psa : SAFEARRAY* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型