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

OpenStreamOnFile

関数
指定ファイルを基にIStreamインターフェイスを開く。
DLLMAPI32.dll呼出規約winapi

シグネチャ

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

HRESULT OpenStreamOnFile(
    LPALLOCATEBUFFER lpAllocateBuffer,
    LPFREEBUFFER lpFreeBuffer,
    DWORD ulFlags,
    CHAR* lpszFileName,
    CHAR* lpszPrefix,   // optional
    IStream** lppStream
);

パラメーター

名前方向説明
lpAllocateBufferLPALLOCATEBUFFERinメモリ確保に用いるAllocateBuffer関数へのポインタ。
lpFreeBufferLPFREEBUFFERin確保したメモリを解放するFreeBuffer関数へのポインタ。
ulFlagsDWORDinストリームの開き方を制御するDWORDフラグ。読み書きや作成モードを指定する。
lpszFileNameCHAR*in対象ファイルのパスを指すANSI文字列。
lpszPrefixCHAR*inoptional一時ファイル名に付与する接頭辞を指すANSI文字列。NULL可。
lppStreamIStream**outファイル上に開かれたIStreamインターフェイスを受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT OpenStreamOnFile(
    LPALLOCATEBUFFER lpAllocateBuffer,
    LPFREEBUFFER lpFreeBuffer,
    DWORD ulFlags,
    CHAR* lpszFileName,
    CHAR* lpszPrefix,   // optional
    IStream** lppStream
);
[DllImport("MAPI32.dll", ExactSpelling = true)]
static extern int OpenStreamOnFile(
    IntPtr lpAllocateBuffer,   // LPALLOCATEBUFFER
    IntPtr lpFreeBuffer,   // LPFREEBUFFER
    uint ulFlags,   // DWORD
    IntPtr lpszFileName,   // CHAR*
    IntPtr lpszPrefix,   // CHAR* optional
    IntPtr lppStream   // IStream** out
);
<DllImport("MAPI32.dll", ExactSpelling:=True)>
Public Shared Function OpenStreamOnFile(
    lpAllocateBuffer As IntPtr,   ' LPALLOCATEBUFFER
    lpFreeBuffer As IntPtr,   ' LPFREEBUFFER
    ulFlags As UInteger,   ' DWORD
    lpszFileName As IntPtr,   ' CHAR*
    lpszPrefix As IntPtr,   ' CHAR* optional
    lppStream As IntPtr   ' IStream** out
) As Integer
End Function
' lpAllocateBuffer : LPALLOCATEBUFFER
' lpFreeBuffer : LPFREEBUFFER
' ulFlags : DWORD
' lpszFileName : CHAR*
' lpszPrefix : CHAR* optional
' lppStream : IStream** out
Declare PtrSafe Function OpenStreamOnFile Lib "mapi32" ( _
    ByVal lpAllocateBuffer As LongPtr, _
    ByVal lpFreeBuffer As LongPtr, _
    ByVal ulFlags As Long, _
    ByVal lpszFileName As LongPtr, _
    ByVal lpszPrefix As LongPtr, _
    ByVal lppStream As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OpenStreamOnFile = ctypes.windll.mapi32.OpenStreamOnFile
OpenStreamOnFile.restype = ctypes.c_int
OpenStreamOnFile.argtypes = [
    ctypes.c_void_p,  # lpAllocateBuffer : LPALLOCATEBUFFER
    ctypes.c_void_p,  # lpFreeBuffer : LPFREEBUFFER
    wintypes.DWORD,  # ulFlags : DWORD
    ctypes.POINTER(ctypes.c_byte),  # lpszFileName : CHAR*
    ctypes.POINTER(ctypes.c_byte),  # lpszPrefix : CHAR* optional
    ctypes.c_void_p,  # lppStream : IStream** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mapi32 = windows.NewLazySystemDLL("MAPI32.dll")
	procOpenStreamOnFile = mapi32.NewProc("OpenStreamOnFile")
)

// lpAllocateBuffer (LPALLOCATEBUFFER), lpFreeBuffer (LPFREEBUFFER), ulFlags (DWORD), lpszFileName (CHAR*), lpszPrefix (CHAR* optional), lppStream (IStream** out)
r1, _, err := procOpenStreamOnFile.Call(
	uintptr(lpAllocateBuffer),
	uintptr(lpFreeBuffer),
	uintptr(ulFlags),
	uintptr(lpszFileName),
	uintptr(lpszPrefix),
	uintptr(lppStream),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function OpenStreamOnFile(
  lpAllocateBuffer: Pointer;   // LPALLOCATEBUFFER
  lpFreeBuffer: Pointer;   // LPFREEBUFFER
  ulFlags: DWORD;   // DWORD
  lpszFileName: Pointer;   // CHAR*
  lpszPrefix: Pointer;   // CHAR* optional
  lppStream: Pointer   // IStream** out
): Integer; stdcall;
  external 'MAPI32.dll' name 'OpenStreamOnFile';
result := DllCall("MAPI32\OpenStreamOnFile"
    , "Ptr", lpAllocateBuffer   ; LPALLOCATEBUFFER
    , "Ptr", lpFreeBuffer   ; LPFREEBUFFER
    , "UInt", ulFlags   ; DWORD
    , "Ptr", lpszFileName   ; CHAR*
    , "Ptr", lpszPrefix   ; CHAR* optional
    , "Ptr", lppStream   ; IStream** out
    , "Int")   ; return: HRESULT
●OpenStreamOnFile(lpAllocateBuffer, lpFreeBuffer, ulFlags, lpszFileName, lpszPrefix, lppStream) = DLL("MAPI32.dll", "int OpenStreamOnFile(void*, void*, dword, void*, void*, void*)")
# 呼び出し: OpenStreamOnFile(lpAllocateBuffer, lpFreeBuffer, ulFlags, lpszFileName, lpszPrefix, lppStream)
# lpAllocateBuffer : LPALLOCATEBUFFER -> "void*"
# lpFreeBuffer : LPFREEBUFFER -> "void*"
# ulFlags : DWORD -> "dword"
# lpszFileName : CHAR* -> "void*"
# lpszPrefix : CHAR* optional -> "void*"
# lppStream : IStream** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef OpenStreamOnFileNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Int8>, Pointer<Int8>, Pointer<Void>);
typedef OpenStreamOnFileDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Int8>, Pointer<Int8>, Pointer<Void>);
final OpenStreamOnFile = DynamicLibrary.open('MAPI32.dll')
    .lookupFunction<OpenStreamOnFileNative, OpenStreamOnFileDart>('OpenStreamOnFile');
// lpAllocateBuffer : LPALLOCATEBUFFER -> Pointer<Void>
// lpFreeBuffer : LPFREEBUFFER -> Pointer<Void>
// ulFlags : DWORD -> Uint32
// lpszFileName : CHAR* -> Pointer<Int8>
// lpszPrefix : CHAR* optional -> Pointer<Int8>
// lppStream : IStream** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenStreamOnFile(
  lpAllocateBuffer: Pointer;   // LPALLOCATEBUFFER
  lpFreeBuffer: Pointer;   // LPFREEBUFFER
  ulFlags: DWORD;   // DWORD
  lpszFileName: Pointer;   // CHAR*
  lpszPrefix: Pointer;   // CHAR* optional
  lppStream: Pointer   // IStream** out
): Integer; stdcall;
  external 'MAPI32.dll' name 'OpenStreamOnFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenStreamOnFile"
  c_OpenStreamOnFile :: Ptr () -> Ptr () -> Word32 -> Ptr Int8 -> Ptr Int8 -> Ptr () -> IO Int32
-- lpAllocateBuffer : LPALLOCATEBUFFER -> Ptr ()
-- lpFreeBuffer : LPFREEBUFFER -> Ptr ()
-- ulFlags : DWORD -> Word32
-- lpszFileName : CHAR* -> Ptr Int8
-- lpszPrefix : CHAR* optional -> Ptr Int8
-- lppStream : IStream** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openstreamonfile =
  foreign "OpenStreamOnFile"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr int8_t) @-> (ptr int8_t) @-> (ptr void) @-> returning int32_t)
(* lpAllocateBuffer : LPALLOCATEBUFFER -> (ptr void) *)
(* lpFreeBuffer : LPFREEBUFFER -> (ptr void) *)
(* ulFlags : DWORD -> uint32_t *)
(* lpszFileName : CHAR* -> (ptr int8_t) *)
(* lpszPrefix : CHAR* optional -> (ptr int8_t) *)
(* lppStream : IStream** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mapi32 (t "MAPI32.dll"))
(cffi:use-foreign-library mapi32)

(cffi:defcfun ("OpenStreamOnFile" open-stream-on-file :convention :stdcall) :int32
  (lp-allocate-buffer :pointer)   ; LPALLOCATEBUFFER
  (lp-free-buffer :pointer)   ; LPFREEBUFFER
  (ul-flags :uint32)   ; DWORD
  (lpsz-file-name :pointer)   ; CHAR*
  (lpsz-prefix :pointer)   ; CHAR* optional
  (lpp-stream :pointer))   ; IStream** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenStreamOnFile = Win32::API::More->new('MAPI32',
    'int OpenStreamOnFile(LPVOID lpAllocateBuffer, LPVOID lpFreeBuffer, DWORD ulFlags, LPVOID lpszFileName, LPVOID lpszPrefix, LPVOID lppStream)');
# my $ret = $OpenStreamOnFile->Call($lpAllocateBuffer, $lpFreeBuffer, $ulFlags, $lpszFileName, $lpszPrefix, $lppStream);
# lpAllocateBuffer : LPALLOCATEBUFFER -> LPVOID
# lpFreeBuffer : LPFREEBUFFER -> LPVOID
# ulFlags : DWORD -> DWORD
# lpszFileName : CHAR* -> LPVOID
# lpszPrefix : CHAR* optional -> LPVOID
# lppStream : IStream** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型