ホーム › System.Ole › SafeArrayGetUBound
SafeArrayGetUBound
関数SAFEARRAYの指定次元の上限インデックスを取得する。
シグネチャ
// OLEAUT32.dll
#include <windows.h>
HRESULT SafeArrayGetUBound(
SAFEARRAY* psa,
DWORD nDim,
INT* plUbound
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| psa | SAFEARRAY* | in | SafeArrayCreate によって作成された配列記述子です。 |
| nDim | DWORD | in | 上限を取得する対象の配列の次元です。 |
| plUbound | INT* | out | 上限です。 |
戻り値の型: HRESULT
公式ドキュメント
指定したセーフ配列の任意の次元における上限を取得します。
戻り値
この関数は次のいずれかの値を返します。
| 戻り値 | 説明 |
|---|---|
| 成功しました。 | |
| 指定したインデックスが範囲外です。 | |
| 上限の計算中にオーバーフローが発生しました。 | |
| 引数のいずれかが無効です。 |
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SafeArrayGetUBound(
SAFEARRAY* psa,
DWORD nDim,
INT* plUbound
);[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SafeArrayGetUBound(
IntPtr psa, // SAFEARRAY*
uint nDim, // DWORD
out int plUbound // INT* out
);<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SafeArrayGetUBound(
psa As IntPtr, ' SAFEARRAY*
nDim As UInteger, ' DWORD
<Out> ByRef plUbound As Integer ' INT* out
) As Integer
End Function' psa : SAFEARRAY*
' nDim : DWORD
' plUbound : INT* out
Declare PtrSafe Function SafeArrayGetUBound Lib "oleaut32" ( _
ByVal psa As LongPtr, _
ByVal nDim As Long, _
ByRef plUbound As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SafeArrayGetUBound = ctypes.windll.oleaut32.SafeArrayGetUBound
SafeArrayGetUBound.restype = ctypes.c_int
SafeArrayGetUBound.argtypes = [
ctypes.c_void_p, # psa : SAFEARRAY*
wintypes.DWORD, # nDim : DWORD
ctypes.POINTER(ctypes.c_int), # plUbound : INT* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLEAUT32.dll')
SafeArrayGetUBound = Fiddle::Function.new(
lib['SafeArrayGetUBound'],
[
Fiddle::TYPE_VOIDP, # psa : SAFEARRAY*
-Fiddle::TYPE_INT, # nDim : DWORD
Fiddle::TYPE_VOIDP, # plUbound : INT* out
],
Fiddle::TYPE_INT)#[link(name = "oleaut32")]
extern "system" {
fn SafeArrayGetUBound(
psa: *mut SAFEARRAY, // SAFEARRAY*
nDim: u32, // DWORD
plUbound: *mut i32 // INT* out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int SafeArrayGetUBound(IntPtr psa, uint nDim, out int plUbound);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SafeArrayGetUBound' -Namespace Win32 -PassThru
# $api::SafeArrayGetUBound(psa, nDim, plUbound)#uselib "OLEAUT32.dll"
#func global SafeArrayGetUBound "SafeArrayGetUBound" sptr, sptr, sptr
; SafeArrayGetUBound varptr(psa), nDim, varptr(plUbound) ; 戻り値は stat
; psa : SAFEARRAY* -> "sptr"
; nDim : DWORD -> "sptr"
; plUbound : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "OLEAUT32.dll" #cfunc global SafeArrayGetUBound "SafeArrayGetUBound" var, int, var ; res = SafeArrayGetUBound(psa, nDim, plUbound) ; psa : SAFEARRAY* -> "var" ; nDim : DWORD -> "int" ; plUbound : INT* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll" #cfunc global SafeArrayGetUBound "SafeArrayGetUBound" sptr, int, sptr ; res = SafeArrayGetUBound(varptr(psa), nDim, varptr(plUbound)) ; psa : SAFEARRAY* -> "sptr" ; nDim : DWORD -> "int" ; plUbound : INT* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT SafeArrayGetUBound(SAFEARRAY* psa, DWORD nDim, INT* plUbound) #uselib "OLEAUT32.dll" #cfunc global SafeArrayGetUBound "SafeArrayGetUBound" var, int, var ; res = SafeArrayGetUBound(psa, nDim, plUbound) ; psa : SAFEARRAY* -> "var" ; nDim : DWORD -> "int" ; plUbound : INT* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT SafeArrayGetUBound(SAFEARRAY* psa, DWORD nDim, INT* plUbound) #uselib "OLEAUT32.dll" #cfunc global SafeArrayGetUBound "SafeArrayGetUBound" intptr, int, intptr ; res = SafeArrayGetUBound(varptr(psa), nDim, varptr(plUbound)) ; psa : SAFEARRAY* -> "intptr" ; nDim : DWORD -> "int" ; plUbound : INT* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
procSafeArrayGetUBound = oleaut32.NewProc("SafeArrayGetUBound")
)
// psa (SAFEARRAY*), nDim (DWORD), plUbound (INT* out)
r1, _, err := procSafeArrayGetUBound.Call(
uintptr(psa),
uintptr(nDim),
uintptr(plUbound),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SafeArrayGetUBound(
psa: Pointer; // SAFEARRAY*
nDim: DWORD; // DWORD
plUbound: Pointer // INT* out
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SafeArrayGetUBound';result := DllCall("OLEAUT32\SafeArrayGetUBound"
, "Ptr", psa ; SAFEARRAY*
, "UInt", nDim ; DWORD
, "Ptr", plUbound ; INT* out
, "Int") ; return: HRESULT●SafeArrayGetUBound(psa, nDim, plUbound) = DLL("OLEAUT32.dll", "int SafeArrayGetUBound(void*, dword, void*)")
# 呼び出し: SafeArrayGetUBound(psa, nDim, plUbound)
# psa : SAFEARRAY* -> "void*"
# nDim : DWORD -> "dword"
# plUbound : INT* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "oleaut32" fn SafeArrayGetUBound(
psa: [*c]SAFEARRAY, // SAFEARRAY*
nDim: u32, // DWORD
plUbound: [*c]i32 // INT* out
) callconv(std.os.windows.WINAPI) i32;proc SafeArrayGetUBound(
psa: ptr SAFEARRAY, # SAFEARRAY*
nDim: uint32, # DWORD
plUbound: ptr int32 # INT* out
): int32 {.importc: "SafeArrayGetUBound", stdcall, dynlib: "OLEAUT32.dll".}pragma(lib, "oleaut32");
extern(Windows)
int SafeArrayGetUBound(
SAFEARRAY* psa, // SAFEARRAY*
uint nDim, // DWORD
int* plUbound // INT* out
);ccall((:SafeArrayGetUBound, "OLEAUT32.dll"), stdcall, Int32,
(Ptr{SAFEARRAY}, UInt32, Ptr{Int32}),
psa, nDim, plUbound)
# psa : SAFEARRAY* -> Ptr{SAFEARRAY}
# nDim : DWORD -> UInt32
# plUbound : INT* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SafeArrayGetUBound(
void* psa,
uint32_t nDim,
int32_t* plUbound);
]]
local oleaut32 = ffi.load("oleaut32")
-- oleaut32.SafeArrayGetUBound(psa, nDim, plUbound)
-- psa : SAFEARRAY*
-- nDim : DWORD
-- plUbound : INT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLEAUT32.dll');
const SafeArrayGetUBound = lib.func('__stdcall', 'SafeArrayGetUBound', 'int32_t', ['void *', 'uint32_t', 'int32_t *']);
// SafeArrayGetUBound(psa, nDim, plUbound)
// psa : SAFEARRAY* -> 'void *'
// nDim : DWORD -> 'uint32_t'
// plUbound : INT* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLEAUT32.dll", {
SafeArrayGetUBound: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SafeArrayGetUBound(psa, nDim, plUbound)
// psa : SAFEARRAY* -> "pointer"
// nDim : DWORD -> "u32"
// plUbound : INT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SafeArrayGetUBound(
void* psa,
uint32_t nDim,
int32_t* plUbound);
C, "OLEAUT32.dll");
// $ffi->SafeArrayGetUBound(psa, nDim, plUbound);
// psa : SAFEARRAY*
// nDim : DWORD
// plUbound : 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 SafeArrayGetUBound(
Pointer psa, // SAFEARRAY*
int nDim, // DWORD
IntByReference plUbound // INT* out
);
}@[Link("oleaut32")]
lib LibOLEAUT32
fun SafeArrayGetUBound = SafeArrayGetUBound(
psa : SAFEARRAY*, # SAFEARRAY*
nDim : UInt32, # DWORD
plUbound : 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 SafeArrayGetUBoundNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Int32>);
typedef SafeArrayGetUBoundDart = int Function(Pointer<Void>, int, Pointer<Int32>);
final SafeArrayGetUBound = DynamicLibrary.open('OLEAUT32.dll')
.lookupFunction<SafeArrayGetUBoundNative, SafeArrayGetUBoundDart>('SafeArrayGetUBound');
// psa : SAFEARRAY* -> Pointer<Void>
// nDim : DWORD -> Uint32
// plUbound : INT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SafeArrayGetUBound(
psa: Pointer; // SAFEARRAY*
nDim: DWORD; // DWORD
plUbound: Pointer // INT* out
): Integer; stdcall;
external 'OLEAUT32.dll' name 'SafeArrayGetUBound';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SafeArrayGetUBound"
c_SafeArrayGetUBound :: Ptr () -> Word32 -> Ptr Int32 -> IO Int32
-- psa : SAFEARRAY* -> Ptr ()
-- nDim : DWORD -> Word32
-- plUbound : INT* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let safearraygetubound =
foreign "SafeArrayGetUBound"
((ptr void) @-> uint32_t @-> (ptr int32_t) @-> returning int32_t)
(* psa : SAFEARRAY* -> (ptr void) *)
(* nDim : DWORD -> uint32_t *)
(* plUbound : 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 ("SafeArrayGetUBound" safe-array-get-ubound :convention :stdcall) :int32
(psa :pointer) ; SAFEARRAY*
(n-dim :uint32) ; DWORD
(pl-ubound :pointer)) ; INT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SafeArrayGetUBound = Win32::API::More->new('OLEAUT32',
'int SafeArrayGetUBound(LPVOID psa, DWORD nDim, LPVOID plUbound)');
# my $ret = $SafeArrayGetUBound->Call($psa, $nDim, $plUbound);
# psa : SAFEARRAY* -> LPVOID
# nDim : DWORD -> DWORD
# plUbound : INT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型