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

ScCopyProps

関数
プロパティ値配列を指定バッファへ連続コピーする。
DLLMAPI32.dll呼出規約winapi

シグネチャ

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

INT ScCopyProps(
    INT cValues,
    SPropValue* lpPropArray,
    void* lpvDst,
    DWORD* lpcb
);

パラメーター

名前方向説明
cValuesINTinコピーするプロパティ値の件数を示す整数。
lpPropArraySPropValue*inoutコピー元のSPropValue構造体配列へのポインタ。
lpvDstvoid*inoutコピー先の連続バッファへのポインタ。相対化されたプロパティ群が格納される。
lpcbDWORD*inout実際に使用したバイト数を返すDWORDポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT ScCopyProps(
    INT cValues,
    SPropValue* lpPropArray,
    void* lpvDst,
    DWORD* lpcb
);
[DllImport("MAPI32.dll", ExactSpelling = true)]
static extern int ScCopyProps(
    int cValues,   // INT
    IntPtr lpPropArray,   // SPropValue* in/out
    IntPtr lpvDst,   // void* in/out
    ref uint lpcb   // DWORD* in/out
);
<DllImport("MAPI32.dll", ExactSpelling:=True)>
Public Shared Function ScCopyProps(
    cValues As Integer,   ' INT
    lpPropArray As IntPtr,   ' SPropValue* in/out
    lpvDst As IntPtr,   ' void* in/out
    ByRef lpcb As UInteger   ' DWORD* in/out
) As Integer
End Function
' cValues : INT
' lpPropArray : SPropValue* in/out
' lpvDst : void* in/out
' lpcb : DWORD* in/out
Declare PtrSafe Function ScCopyProps Lib "mapi32" ( _
    ByVal cValues As Long, _
    ByVal lpPropArray As LongPtr, _
    ByVal lpvDst As LongPtr, _
    ByRef lpcb As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ScCopyProps = ctypes.windll.mapi32.ScCopyProps
ScCopyProps.restype = ctypes.c_int
ScCopyProps.argtypes = [
    ctypes.c_int,  # cValues : INT
    ctypes.c_void_p,  # lpPropArray : SPropValue* in/out
    ctypes.POINTER(None),  # lpvDst : void* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpcb : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mapi32 = windows.NewLazySystemDLL("MAPI32.dll")
	procScCopyProps = mapi32.NewProc("ScCopyProps")
)

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

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

typedef ScCopyPropsNative = Int32 Function(Int32, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef ScCopyPropsDart = int Function(int, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final ScCopyProps = DynamicLibrary.open('MAPI32.dll')
    .lookupFunction<ScCopyPropsNative, ScCopyPropsDart>('ScCopyProps');
// cValues : INT -> Int32
// lpPropArray : SPropValue* in/out -> Pointer<Void>
// lpvDst : void* in/out -> Pointer<Void>
// lpcb : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ScCopyProps(
  cValues: Integer;   // INT
  lpPropArray: Pointer;   // SPropValue* in/out
  lpvDst: Pointer;   // void* in/out
  lpcb: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'MAPI32.dll' name 'ScCopyProps';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ScCopyProps"
  c_ScCopyProps :: Int32 -> Ptr () -> Ptr () -> Ptr Word32 -> IO Int32
-- cValues : INT -> Int32
-- lpPropArray : SPropValue* in/out -> Ptr ()
-- lpvDst : void* in/out -> Ptr ()
-- lpcb : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sccopyprops =
  foreign "ScCopyProps"
    (int32_t @-> (ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* cValues : INT -> int32_t *)
(* lpPropArray : SPropValue* in/out -> (ptr void) *)
(* lpvDst : void* in/out -> (ptr void) *)
(* lpcb : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mapi32 (t "MAPI32.dll"))
(cffi:use-foreign-library mapi32)

(cffi:defcfun ("ScCopyProps" sc-copy-props :convention :stdcall) :int32
  (c-values :int32)   ; INT
  (lp-prop-array :pointer)   ; SPropValue* in/out
  (lpv-dst :pointer)   ; void* in/out
  (lpcb :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ScCopyProps = Win32::API::More->new('MAPI32',
    'int ScCopyProps(int cValues, LPVOID lpPropArray, LPVOID lpvDst, LPVOID lpcb)');
# my $ret = $ScCopyProps->Call($cValues, $lpPropArray, $lpvDst, $lpcb);
# cValues : INT -> int
# lpPropArray : SPropValue* in/out -> LPVOID
# lpvDst : void* in/out -> LPVOID
# lpcb : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型