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

SafeArrayLock

関数
SAFEARRAYをロックしデータへの直接アクセスを可能にする。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SafeArrayLock(
    SAFEARRAY* psa
);

パラメーター

名前方向説明
psaSAFEARRAY*inSafeArrayCreate によって作成された配列ディスクリプタ。

戻り値の型: HRESULT

公式ドキュメント

配列のロックカウントをインクリメントし、配列ディスクリプタの pvData に配列データへのポインタを設定します。

戻り値

この関数は次のいずれかの値を返すことがあります。

戻り値 説明
S_OK
成功しました。
E_INVALIDARG
引数 psa が無効です。
E_UNEXPECTED
配列をロックできませんでした。

解説(Remarks)

配列ディスクリプタ内のポインタは、SafeArrayUnlock 関数が呼び出されるまで有効です。SafeArrayLock の呼び出しはネストでき、その場合は同じ回数だけ SafeArrayUnlock を呼び出す必要があります。

配列はロックされている間は削除できません。

スレッドセーフ

SAFEARRAY データ型のすべてのパブリックな静的(Visual Basic では Shared)メンバーはスレッドセーフです。インスタンスメンバーはスレッドセーフであることが保証されません。

たとえば、SafeArrayLock 関数と SafeArrayUnlock 関数を使用するアプリケーションを考えてみます。これらの関数が同一の SAFEARRAY データ型インスタンスに対して異なるスレッドから同時に呼び出されると、ロックカウントに不整合が生じる可能性があります。これは最終的に SafeArrayUnlock 関数が E_UNEXPECTED を返す原因となります。独自の同期コードを用意することでこれを防止できます。

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

各言語での呼び出し定義

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

HRESULT SafeArrayLock(
    SAFEARRAY* psa
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayLock(
    IntPtr psa   // SAFEARRAY*
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayLock(
    psa As IntPtr   ' SAFEARRAY*
) As Integer
End Function
' psa : SAFEARRAY*
Declare PtrSafe Function SafeArrayLock 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

SafeArrayLock = ctypes.windll.oleaut32.SafeArrayLock
SafeArrayLock.restype = ctypes.c_int
SafeArrayLock.argtypes = [
    ctypes.c_void_p,  # psa : SAFEARRAY*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayLock = Fiddle::Function.new(
  lib['SafeArrayLock'],
  [
    Fiddle::TYPE_VOIDP,  # psa : SAFEARRAY*
  ],
  Fiddle::TYPE_INT)
#[link(name = "oleaut32")]
extern "system" {
    fn SafeArrayLock(
        psa: *mut SAFEARRAY  // SAFEARRAY*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int SafeArrayLock(IntPtr psa);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayLock' -Namespace Win32 -PassThru
# $api::SafeArrayLock(psa)
#uselib "OLEAUT32.dll"
#func global SafeArrayLock "SafeArrayLock" sptr
; SafeArrayLock varptr(psa)   ; 戻り値は stat
; psa : SAFEARRAY* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLEAUT32.dll"
#cfunc global SafeArrayLock "SafeArrayLock" var
; res = SafeArrayLock(psa)
; psa : SAFEARRAY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SafeArrayLock(SAFEARRAY* psa)
#uselib "OLEAUT32.dll"
#cfunc global SafeArrayLock "SafeArrayLock" var
; res = SafeArrayLock(psa)
; psa : SAFEARRAY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayLock = oleaut32.NewProc("SafeArrayLock")
)

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

extern "oleaut32" fn SafeArrayLock(
    psa: [*c]SAFEARRAY // SAFEARRAY*
) callconv(std.os.windows.WINAPI) i32;
proc SafeArrayLock(
    psa: ptr SAFEARRAY  # SAFEARRAY*
): int32 {.importc: "SafeArrayLock", stdcall, dynlib: "OLEAUT32.dll".}
pragma(lib, "oleaut32");
extern(Windows)
int SafeArrayLock(
    SAFEARRAY* psa   // SAFEARRAY*
);
ccall((:SafeArrayLock, "OLEAUT32.dll"), stdcall, Int32,
      (Ptr{SAFEARRAY},),
      psa)
# psa : SAFEARRAY* -> Ptr{SAFEARRAY}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SafeArrayLock(
    void* psa);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SafeArrayLock(psa)
-- psa : SAFEARRAY*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SafeArrayLock = lib.func('__stdcall', 'SafeArrayLock', 'int32_t', ['void *']);
// SafeArrayLock(psa)
// psa : SAFEARRAY* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLEAUT32.dll", {
  SafeArrayLock: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.SafeArrayLock(psa)
// psa : SAFEARRAY* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SafeArrayLock(
    void* psa);
C, "OLEAUT32.dll");
// $ffi->SafeArrayLock(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 SafeArrayLock(
        Pointer psa   // SAFEARRAY*
    );
}
@[Link("oleaut32")]
lib LibOLEAUT32
  fun SafeArrayLock = SafeArrayLock(
    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 SafeArrayLockNative = Int32 Function(Pointer<Void>);
typedef SafeArrayLockDart = int Function(Pointer<Void>);
final SafeArrayLock = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SafeArrayLockNative, SafeArrayLockDart>('SafeArrayLock');
// psa : SAFEARRAY* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SafeArrayLock(
  psa: Pointer   // SAFEARRAY*
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'SafeArrayLock';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SafeArrayLock"
  c_SafeArrayLock :: Ptr () -> IO Int32
-- psa : SAFEARRAY* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let safearraylock =
  foreign "SafeArrayLock"
    ((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 ("SafeArrayLock" safe-array-lock :convention :stdcall) :int32
  (psa :pointer))   ; SAFEARRAY*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SafeArrayLock = Win32::API::More->new('OLEAUT32',
    'int SafeArrayLock(LPVOID psa)');
# my $ret = $SafeArrayLock->Call($psa);
# psa : SAFEARRAY* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型