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

MapiFileDesc

構造体
サイズx64: 40 バイト / x86: 24 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
ulReservedDWORD4+0+0予約済みです。0 でなければなりません。
flFlagsDWORD4+4+4

オプションフラグのビットマスクです。次のフラグを設定できます。

意味
MAPI_OLE
添付ファイルは OLE オブジェクトです。MAPI_OLE_STATIC も設定されている場合、添付ファイルは静的 OLE オブジェクトです。MAPI_OLE_STATIC が設定されていない場合、添付ファイルは埋め込み OLE オブジェクトです。
MAPI_OLE_STATIC
添付ファイルは静的 OLE オブジェクトです。

どちらのフラグも設定されていない場合、添付ファイルはデータファイルとして扱われます。

nPositionDWORD4+8+8添付ファイルをメッセージ本文のどの位置に表示するかを示す整数です。添付ファイルは、メッセージ本文内の特定の位置にある文字を置き換えます。つまり、添付ファイルは MapiMessage 構造体のフィールド NoteText[nPosition] にある文字を置き換えます。値が -1 (0xFFFFFFFF) の場合は、添付ファイルの位置が示されていないことを意味します。この場合、クライアントアプリケーションはユーザーが添付ファイルにアクセスするための手段を用意する必要があります。
lpszPathNameLPSTR8/4+16+12添付ファイルの完全修飾パスへのポインターです。このパスには、ディスクドライブ名とディレクトリ名を含める必要があります。
lpszFileNameLPSTR8/4+24+16受信者に表示される添付ファイル名へのポインターです。一時ファイルが使用されている場合、lpszPathName メンバーのファイル名とは異なることがあります。lpszFileName メンバーが空または NULL の場合は、lpszPathName のファイル名が使用されます。
lpFileTypevoid*8/4+32+20添付ファイルのファイル形式へのポインターです。この形式は MapiFileTagExt 構造体で表すことができます。NULL は、不明なファイル形式、またはオペレーティングシステムによって判別されるファイル形式であることを示します。

公式ドキュメント

MapiFileDesc 構造体には、一時ファイルとして格納されたメッセージの添付ファイルを含むファイルに関する情報が格納されます。そのファイルには、静的 OLE オブジェクト、埋め込み OLE オブジェクト、埋め込みメッセージ、およびその他の種類のファイルを含めることができます。Unicode をサポートする場合は、MapiFileDescW 構造体を使用してください。

解説(Remarks)

シンプル MAPI では、次の 3 種類の埋め込み添付ファイルを扱います。

データファイルの添付は、単なるデータファイルです。OLE オブジェクトファイルの添付は、メッセージ本文内に表示される OLE オブジェクトです。OLE の添付ファイルが編集可能な場合、受信者がそれをダブルクリックすると、ソースアプリケーションが起動して編集セッションを処理します。OLE の添付ファイルが静的な場合、オブジェクトを編集することはできません。特定の添付ファイルの種類は、MapiFileDesc 構造体の flFlags メンバーに設定されたフラグによって決まります。埋め込みメッセージは、lpszFileName メンバーの .MSG 拡張子によって識別できます。

OLE オブジェクトファイルは、OLE オブジェクトストリームをファイルとして表現したものです。クライアントアプリケーションは、ファイルの内容を読み取る OLESTREAM オブジェクトを指定して OLE の関数 OleLoadFromStream を呼び出すことで、ファイルから OLE オブジェクトを再作成できます。送信メッセージに OLE ファイルの添付を含める場合は、OLE オブジェクトストリームを添付ファイルとして使用するファイルに直接書き込む必要があります。

MapiFileDescnPosition メンバーを使用する際、クライアントアプリケーションは 2 つの添付ファイルを同じ位置に配置しないでください。クライアントアプリケーションは、メッセージ本文の末尾を超えた位置にある添付ファイルを表示しない場合があります。

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

各言語での定義

#include <windows.h>

// MapiFileDesc  (x64 40 / x86 24 バイト)
typedef struct MapiFileDesc {
    DWORD ulReserved;
    DWORD flFlags;
    DWORD nPosition;
    LPSTR lpszPathName;
    LPSTR lpszFileName;
    void* lpFileType;
} MapiFileDesc;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct MapiFileDesc
{
    public uint ulReserved;
    public uint flFlags;
    public uint nPosition;
    public IntPtr lpszPathName;
    public IntPtr lpszFileName;
    public IntPtr lpFileType;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure MapiFileDesc
    Public ulReserved As UInteger
    Public flFlags As UInteger
    Public nPosition As UInteger
    Public lpszPathName As IntPtr
    Public lpszFileName As IntPtr
    Public lpFileType As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class MapiFileDesc(ctypes.Structure):
    _fields_ = [
        ("ulReserved", wintypes.DWORD),
        ("flFlags", wintypes.DWORD),
        ("nPosition", wintypes.DWORD),
        ("lpszPathName", ctypes.c_void_p),
        ("lpszFileName", ctypes.c_void_p),
        ("lpFileType", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct MapiFileDesc {
    pub ulReserved: u32,
    pub flFlags: u32,
    pub nPosition: u32,
    pub lpszPathName: *mut core::ffi::c_void,
    pub lpszFileName: *mut core::ffi::c_void,
    pub lpFileType: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type MapiFileDesc struct {
	ulReserved uint32
	flFlags uint32
	nPosition uint32
	lpszPathName uintptr
	lpszFileName uintptr
	lpFileType uintptr
}
type
  MapiFileDesc = record
    ulReserved: DWORD;
    flFlags: DWORD;
    nPosition: DWORD;
    lpszPathName: Pointer;
    lpszFileName: Pointer;
    lpFileType: Pointer;
  end;
const MapiFileDesc = extern struct {
    ulReserved: u32,
    flFlags: u32,
    nPosition: u32,
    lpszPathName: ?*anyopaque,
    lpszFileName: ?*anyopaque,
    lpFileType: ?*anyopaque,
};
type
  MapiFileDesc {.bycopy.} = object
    ulReserved: uint32
    flFlags: uint32
    nPosition: uint32
    lpszPathName: pointer
    lpszFileName: pointer
    lpFileType: pointer
struct MapiFileDesc
{
    uint ulReserved;
    uint flFlags;
    uint nPosition;
    void* lpszPathName;
    void* lpszFileName;
    void* lpFileType;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; MapiFileDesc サイズ: 24 バイト(x86)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; ulReserved : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; flFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; nPosition : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; lpszPathName : LPSTR (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; lpszFileName : LPSTR (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; lpFileType : void* (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; MapiFileDesc サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; ulReserved : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; flFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; nPosition : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; lpszPathName : LPSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; lpszFileName : LPSTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; lpFileType : void* (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global MapiFileDesc
    #field int ulReserved
    #field int flFlags
    #field int nPosition
    #field intptr lpszPathName
    #field intptr lpszFileName
    #field intptr lpFileType
#endstruct

stdim st, MapiFileDesc        ; NSTRUCT 変数を確保
st->ulReserved = 100
mes "ulReserved=" + st->ulReserved