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

SafeArrayGetLBound

関数
SAFEARRAYの指定次元の下限インデックスを取得する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SafeArrayGetLBound(
    SAFEARRAY* psa,
    DWORD nDim,
    INT* plLbound
);

パラメーター

名前方向説明
psaSAFEARRAY*inSafeArrayCreate によって作成された配列記述子。
nDimDWORDin下限を取得する対象の配列の次元。
plLboundINT*out下限。

戻り値の型: HRESULT

公式ドキュメント

指定したセーフ配列の任意の次元の下限を取得します。

戻り値

この関数は次のいずれかの値を返します。

戻り値 説明
S_OK
成功しました。
E_INVALIDARG
引数のいずれかが無効です。
DISP_E_BADINDEX
指定したインデックスが範囲外です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT SafeArrayGetLBound(
    SAFEARRAY* psa,
    DWORD nDim,
    INT* plLbound
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayGetLBound(
    IntPtr psa,   // SAFEARRAY*
    uint nDim,   // DWORD
    out int plLbound   // INT* out
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayGetLBound(
    psa As IntPtr,   ' SAFEARRAY*
    nDim As UInteger,   ' DWORD
    <Out> ByRef plLbound As Integer   ' INT* out
) As Integer
End Function
' psa : SAFEARRAY*
' nDim : DWORD
' plLbound : INT* out
Declare PtrSafe Function SafeArrayGetLBound Lib "oleaut32" ( _
    ByVal psa As LongPtr, _
    ByVal nDim As Long, _
    ByRef plLbound As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SafeArrayGetLBound = ctypes.windll.oleaut32.SafeArrayGetLBound
SafeArrayGetLBound.restype = ctypes.c_int
SafeArrayGetLBound.argtypes = [
    ctypes.c_void_p,  # psa : SAFEARRAY*
    wintypes.DWORD,  # nDim : DWORD
    ctypes.POINTER(ctypes.c_int),  # plLbound : INT* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSafeArrayGetLBound = oleaut32.NewProc("SafeArrayGetLBound")
)

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

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

typedef SafeArrayGetLBoundNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Int32>);
typedef SafeArrayGetLBoundDart = int Function(Pointer<Void>, int, Pointer<Int32>);
final SafeArrayGetLBound = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SafeArrayGetLBoundNative, SafeArrayGetLBoundDart>('SafeArrayGetLBound');
// psa : SAFEARRAY* -> Pointer<Void>
// nDim : DWORD -> Uint32
// plLbound : INT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SafeArrayGetLBound(
  psa: Pointer;   // SAFEARRAY*
  nDim: DWORD;   // DWORD
  plLbound: Pointer   // INT* out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'SafeArrayGetLBound';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let safearraygetlbound =
  foreign "SafeArrayGetLBound"
    ((ptr void) @-> uint32_t @-> (ptr int32_t) @-> returning int32_t)
(* psa : SAFEARRAY* -> (ptr void) *)
(* nDim : DWORD -> uint32_t *)
(* plLbound : INT* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("SafeArrayGetLBound" safe-array-get-lbound :convention :stdcall) :int32
  (psa :pointer)   ; SAFEARRAY*
  (n-dim :uint32)   ; DWORD
  (pl-lbound :pointer))   ; INT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SafeArrayGetLBound = Win32::API::More->new('OLEAUT32',
    'int SafeArrayGetLBound(LPVOID psa, DWORD nDim, LPVOID plLbound)');
# my $ret = $SafeArrayGetLBound->Call($psa, $nDim, $plLbound);
# psa : SAFEARRAY* -> LPVOID
# nDim : DWORD -> DWORD
# plLbound : INT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型