ホーム › Graphics.Printing › MXDC_ESCAPE_HEADER_T

MXDC_ESCAPE_HEADER_T

構造体

サイズx64: 12 バイト / x86: 12 バイトパッキング1

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

フィールド

フィールド	型	サイズ	x64	x86	説明
cbInput	DWORD	4	+0	+0	入力データのサイズをバイト単位で指定する。
cbOutput	DWORD	4	+4	+4	出力データのサイズをバイト単位で指定する。
opCode	DWORD	4	+8	+8	実行するMXDCエスケープ操作のコード。処理種別を示す。

公式ドキュメント

MXDC_ESCAPE_HEADER_T 構造体は、nEscape パラメーターに MXDC_ESCAPE を指定して ExtEscape を呼び出す際の操作コードを保持します。また、入力バッファーと出力バッファーのサイズも指定します。

解説(Remarks)

MXDC_ESCAPE を呼び出す前に、アプリケーションはまず GETTECHNOLOGY エスケープを指定して ExtEscape を呼び出し、ドライバーが MXDC であることを確認する必要があります。ドライバーが MXDC の場合、この関数は 0 で終わる文字列 "http://schemas.microsoft.com/xps/2005/06" を返します。

この構造体は、常に ExtEscape 関数の lpszInData パラメーターに渡されるデータの先頭に配置されます。

opCode が MXDCOP_GET_FILENAME の場合:

ExtEscape 関数の lpszInData パラメーターは、MXDC_ESCAPE_HEADER_T 構造体のみで構成されます。
出力ファイル名は、ExtEscape を 2 回呼び出して取得します。
1. 1 回目は、ExtEscape の cbOutput パラメーターに 4 を渡します。lpszOutData パラメーターには、割り当て済みの任意の 4 バイトのメモリを指すように設定します。完全修飾ファイルパスのサイズが ExtEscape の lpszOutData パラメーターに返されます。
2. 次に、もう一度この関数を呼び出します。今度は cbOutput と cbInput の両方に 4+ DataSize を設定します。完全修飾ファイルパスは MxdcGetFileNameData 構造体で返されます。

opCode が MXDCOP_PRINTTICKET_FIXED_DOC_SEQ または MXDCOP_PRINTTICKET_FIXED_DOC の場合:

ExtEscape 関数の lpszInData パラメーターは、MXDC_ESCAPE_HEADER_T 構造体と MxdcPrintTicketPassthrough 構造体を連結した MxdcPrintTicketEscape 構造体で構成されます。
ExtEscape の呼び出しは、StartDoc の呼び出しと EndDoc の呼び出しの間で行う必要があります。

opCode が MXDCOP_PRINTTICKET_FIXED_PAGE の場合:

ExtEscape 関数の lpszInData パラメーターは、MXDC_ESCAPE_HEADER_T 構造体と MxdcPrintTicketPassthrough 構造体を連結した MxdcPrintTicketEscape 構造体で構成されます。
ExtEscape の呼び出しは、StartPage の呼び出しと EndPage の呼び出しの間で行う必要があります。

opCode が MXDCOP_SET_S0PAGE の場合:

ExtEscape 関数の lpszInData パラメーターは、MXDC_ESCAPE_HEADER_T 構造体と MxdcS0PageData 構造体を連結した MxdcS0PagePassthroughEscape 構造体で構成されます。
ExtEscape の呼び出しは、StartPage の呼び出しと EndPage の呼び出しの間で行う必要があります。
XML の検証は、呼び出し元のアプリケーションが行う必要があります。
MXDCOP_SET_S0PAGE を指定して呼び出す前に、ページ上の各リソースについて opCode に MXDCOP_SET_S0PAGE_RESOURCE を指定して ExtEscape を呼び出すと、ストリーミングでの処理がより効率的になります。

opCode が MXDCOP_SET_S0PAGE_RESOURCE の場合:

ExtEscape 関数の lpszInData パラメーターは、MXDC_ESCAPE_HEADER_T 構造体と MxdcXpsS0PageResource 構造体を連結した MxdcS0PageResourceEscape 構造体で構成されます。
ExtEscape の呼び出しは、StartPage の呼び出しと EndPage の呼び出しの間で行う必要がありますが、StartPage と EndPage の呼び出しの間でこのような呼び出しを複数回行うことができます。
MXDCOP_SET_S0PAGE を指定して呼び出す前に、ページ上の各リソースについて opCode に MXDCOP_SET_S0PAGE_RESOURCE を指定して ExtEscape を呼び出すと、ストリーミングでの処理がより効率的になります。

opCode が MXDCOP_SET_XPSPASSTHRU_MODE の場合:

ExtEscape 関数の lpszInData パラメーターは、MXDC_ESCAPE_HEADER_T 構造体のみで構成されます。
この呼び出しは、StartDoc の呼び出しよりも前に行う必要があります。

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

各言語での定義

#include <windows.h>

// MXDC_ESCAPE_HEADER_T  (x64 12 / x86 12 バイト)
#pragma pack(push, 1)
typedef struct MXDC_ESCAPE_HEADER_T {
    DWORD cbInput;
    DWORD cbOutput;
    DWORD opCode;
} MXDC_ESCAPE_HEADER_T;
#pragma pack(pop)

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct MXDC_ESCAPE_HEADER_T
{
    public uint cbInput;
    public uint cbOutput;
    public uint opCode;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure MXDC_ESCAPE_HEADER_T
    Public cbInput As UInteger
    Public cbOutput As UInteger
    Public opCode As UInteger
End Structure

import ctypes
from ctypes import wintypes

class MXDC_ESCAPE_HEADER_T(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("cbInput", wintypes.DWORD),
        ("cbOutput", wintypes.DWORD),
        ("opCode", wintypes.DWORD),
    ]

#[repr(C, packed(1))]
pub struct MXDC_ESCAPE_HEADER_T {
    pub cbInput: u32,
    pub cbOutput: u32,
    pub opCode: u32,
}

import "golang.org/x/sys/windows"

type MXDC_ESCAPE_HEADER_T struct {
	cbInput uint32
	cbOutput uint32
	opCode uint32
}

type
  MXDC_ESCAPE_HEADER_T = packed record
    cbInput: DWORD;
    cbOutput: DWORD;
    opCode: DWORD;
  end;

const MXDC_ESCAPE_HEADER_T = extern struct {
    cbInput: u32,
    cbOutput: u32,
    opCode: u32,
};

type
  MXDC_ESCAPE_HEADER_T {.packed.} = object
    cbInput: uint32
    cbOutput: uint32
    opCode: uint32

align(1)
struct MXDC_ESCAPE_HEADER_T
{
    uint cbInput;
    uint cbOutput;
    uint opCode;
}

HSP用定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; MXDC_ESCAPE_HEADER_T サイズ: 12 バイト(x64)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; cbInput : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; cbOutput : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; opCode : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global MXDC_ESCAPE_HEADER_T, pack=1
    #field int cbInput
    #field int cbOutput
    #field int opCode
#endstruct

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