Win32 API 日本語リファレンス
ホームUI.Controls › DSA_InsertItem

DSA_InsertItem

関数
動的構造体配列の指定位置に要素を挿入する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT DSA_InsertItem(
    HDSA hdsa,
    INT i,
    const void* pitem
);

パラメーター

名前方向説明
hdsaHDSAin項目を挿入する DSA のハンドル。
iINTinDSA 内で新しい項目を挿入する位置。配列の末尾に項目を挿入する場合は DSA_APPEND を指定します。
pitemvoid*in挿入する項目へのポインター。

戻り値の型: INT

公式ドキュメント

動的構造体配列 (DSA) に新しい項目を挿入します。必要に応じて、DSA は新しい項目を格納できるように拡張されます。

戻り値

型: int

挿入に成功した場合は新しい項目のインデックスを返します。挿入に失敗した場合は DSA_ERR (-1) を返します。

解説(Remarks)

pItem が指す実際のデータは DSA にコピーされます。そのため、その項目に対して以降に行う操作は、元のコピーには影響しません。

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

各言語での呼び出し定義

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

INT DSA_InsertItem(
    HDSA hdsa,
    INT i,
    const void* pitem
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int DSA_InsertItem(
    IntPtr hdsa,   // HDSA
    int i,   // INT
    IntPtr pitem   // void*
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function DSA_InsertItem(
    hdsa As IntPtr,   ' HDSA
    i As Integer,   ' INT
    pitem As IntPtr   ' void*
) As Integer
End Function
' hdsa : HDSA
' i : INT
' pitem : void*
Declare PtrSafe Function DSA_InsertItem Lib "comctl32" ( _
    ByVal hdsa As LongPtr, _
    ByVal i As Long, _
    ByVal pitem As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DSA_InsertItem = ctypes.windll.comctl32.DSA_InsertItem
DSA_InsertItem.restype = ctypes.c_int
DSA_InsertItem.argtypes = [
    ctypes.c_ssize_t,  # hdsa : HDSA
    ctypes.c_int,  # i : INT
    ctypes.POINTER(None),  # pitem : void*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
DSA_InsertItem = Fiddle::Function.new(
  lib['DSA_InsertItem'],
  [
    Fiddle::TYPE_INTPTR_T,  # hdsa : HDSA
    Fiddle::TYPE_INT,  # i : INT
    Fiddle::TYPE_VOIDP,  # pitem : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn DSA_InsertItem(
        hdsa: isize,  // HDSA
        i: i32,  // INT
        pitem: *const ()  // void*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("COMCTL32.dll")]
public static extern int DSA_InsertItem(IntPtr hdsa, int i, IntPtr pitem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_DSA_InsertItem' -Namespace Win32 -PassThru
# $api::DSA_InsertItem(hdsa, i, pitem)
#uselib "COMCTL32.dll"
#func global DSA_InsertItem "DSA_InsertItem" sptr, sptr, sptr
; DSA_InsertItem hdsa, i, pitem   ; 戻り値は stat
; hdsa : HDSA -> "sptr"
; i : INT -> "sptr"
; pitem : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "COMCTL32.dll"
#cfunc global DSA_InsertItem "DSA_InsertItem" sptr, int, sptr
; res = DSA_InsertItem(hdsa, i, pitem)
; hdsa : HDSA -> "sptr"
; i : INT -> "int"
; pitem : void* -> "sptr"
; INT DSA_InsertItem(HDSA hdsa, INT i, void* pitem)
#uselib "COMCTL32.dll"
#cfunc global DSA_InsertItem "DSA_InsertItem" intptr, int, intptr
; res = DSA_InsertItem(hdsa, i, pitem)
; hdsa : HDSA -> "intptr"
; i : INT -> "int"
; pitem : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procDSA_InsertItem = comctl32.NewProc("DSA_InsertItem")
)

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

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

typedef DSA_InsertItemNative = Int32 Function(IntPtr, Int32, Pointer<Void>);
typedef DSA_InsertItemDart = int Function(int, int, Pointer<Void>);
final DSA_InsertItem = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<DSA_InsertItemNative, DSA_InsertItemDart>('DSA_InsertItem');
// hdsa : HDSA -> IntPtr
// i : INT -> Int32
// pitem : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DSA_InsertItem(
  hdsa: NativeInt;   // HDSA
  i: Integer;   // INT
  pitem: Pointer   // void*
): Integer; stdcall;
  external 'COMCTL32.dll' name 'DSA_InsertItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DSA_InsertItem"
  c_DSA_InsertItem :: CIntPtr -> Int32 -> Ptr () -> IO Int32
-- hdsa : HDSA -> CIntPtr
-- i : INT -> Int32
-- pitem : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsa_insertitem =
  foreign "DSA_InsertItem"
    (intptr_t @-> int32_t @-> (ptr void) @-> returning int32_t)
(* hdsa : HDSA -> intptr_t *)
(* i : INT -> int32_t *)
(* pitem : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("DSA_InsertItem" dsa-insert-item :convention :stdcall) :int32
  (hdsa :int64)   ; HDSA
  (i :int32)   ; INT
  (pitem :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DSA_InsertItem = Win32::API::More->new('COMCTL32',
    'int DSA_InsertItem(LPARAM hdsa, int i, LPVOID pitem)');
# my $ret = $DSA_InsertItem->Call($hdsa, $i, $pitem);
# hdsa : HDSA -> LPARAM
# i : INT -> int
# pitem : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。