Win32 API 日本語リファレンス
ホーム › Media.DeviceManager › MTP_COMMAND_DATA_IN

MTP_COMMAND_DATA_IN

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 35 バイト / x86: 35 バイトパッキング1

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

フィールド

フィールド型サイズx64x86説明
OpCodeWORD2+0+0操作コードです。
NumParamsDWORD4+2+2渡されるパラメーターの数です。
ParamsDWORD20+6+6コマンドへのパラメーターです。MTP_COMMAND_MAX_PARAMS は値 5 を持つ定義済み定数です。
NextPhaseDWORD4+26+26コマンドに読み取りデータフェーズ、書き込みデータフェーズ、またはデータフェーズなしのいずれがあるかを示します。有効な値は次の表に定義されています。
CommandWriteDataSizeDWORD4+30+30CommandWriteData[1] のデータサイズ (バイト単位) です。
CommandWriteDataBYTE1+34+34省略可能です。NextPhase が MTP_NEXTPHASE_WRITE_DATA の場合に、デバイスへ書き込むデータの先頭バイトです。

公式ドキュメント

MTP_COMMAND_DATA_IN 構造体は、IWMDMDevice3::DeviceIoControl メソッドを使用してデバイスへ送信される Media Transport Protocol (MTP) カスタムコマンドを格納します。

解説(Remarks)

入力バッファーには、適切に設定された MTP_COMMAND_DATA_IN 構造体が格納されている必要があります。処理の終了時に、デバイスドライバーは MTP_COMMAND_DATA_OUT 構造体を設定し、出力バッファーに保存します。したがって、すべての要求では、少なくとも SIZEOF_REQUIRED_COMMAND_DATA_IN バイトの入力バッファーが必要です。これは次のように定義されます。

#define SIZEOF_REQUIRED_COMMAND_DATA_IN (sizeof(MTP_COMMAND_DATA_IN)-1)

また、少なくとも SIZEOF_REQUIRED_COMMAND_DATA_OUT バイトの出力バッファーが必要です。これは次のように定義されます。

#define SIZEOF_REQUIRED_COMMAND_DATA_OUT (sizeof(MTP_COMMAND_DATA_OUT)-1)

すべてのコマンドは自己完結型である、つまり 1 回の呼び出しで完全に処理できることが前提とされています。従来の意味でのチャンク分割はサポートされないため、このことは長大なデータ転送に影響します。(たとえば 3 メガバイトの読み取りを発行するには、呼び出し元は 3 MB に SIZEOF_REQUIRED_COMMAND_DATA_OUT バイトを加えた出力バッファーを確保する必要があります。) 長大なデータ転送は、このメソッドではなく、通常のデータ転送 API を使用して行ってください。

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

各言語での定義

#include <windows.h>

// MTP_COMMAND_DATA_IN  (x64 35 / x86 35 バイト)
#pragma pack(push, 1)
typedef struct MTP_COMMAND_DATA_IN {
    WORD OpCode;
    DWORD NumParams;
    DWORD Params[5];
    DWORD NextPhase;
    DWORD CommandWriteDataSize;
    BYTE CommandWriteData[1];
} MTP_COMMAND_DATA_IN;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct MTP_COMMAND_DATA_IN
{
    public ushort OpCode;
    public uint NumParams;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 5)] public uint[] Params;
    public uint NextPhase;
    public uint CommandWriteDataSize;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public byte[] CommandWriteData;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure MTP_COMMAND_DATA_IN
    Public OpCode As UShort
    Public NumParams As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=5)> Public Params() As UInteger
    Public NextPhase As UInteger
    Public CommandWriteDataSize As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public CommandWriteData() As Byte
End Structure
import ctypes
from ctypes import wintypes

class MTP_COMMAND_DATA_IN(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("OpCode", ctypes.c_ushort),
        ("NumParams", wintypes.DWORD),
        ("Params", wintypes.DWORD * 5),
        ("NextPhase", wintypes.DWORD),
        ("CommandWriteDataSize", wintypes.DWORD),
        ("CommandWriteData", ctypes.c_ubyte * 1),
    ]
#[repr(C, packed(1))]
pub struct MTP_COMMAND_DATA_IN {
    pub OpCode: u16,
    pub NumParams: u32,
    pub Params: [u32; 5],
    pub NextPhase: u32,
    pub CommandWriteDataSize: u32,
    pub CommandWriteData: [u8; 1],
}
import "golang.org/x/sys/windows"

type MTP_COMMAND_DATA_IN struct {
	OpCode uint16
	NumParams uint32
	Params [5]uint32
	NextPhase uint32
	CommandWriteDataSize uint32
	CommandWriteData [1]byte
}
type
  MTP_COMMAND_DATA_IN = packed record
    OpCode: Word;
    NumParams: DWORD;
    Params: array[0..4] of DWORD;
    NextPhase: DWORD;
    CommandWriteDataSize: DWORD;
    CommandWriteData: array[0..0] of Byte;
  end;
const MTP_COMMAND_DATA_IN = extern struct {
    OpCode: u16,
    NumParams: u32,
    Params: [5]u32,
    NextPhase: u32,
    CommandWriteDataSize: u32,
    CommandWriteData: [1]u8,
};
type
  MTP_COMMAND_DATA_IN {.packed.} = object
    OpCode: uint16
    NumParams: uint32
    Params: array[5, uint32]
    NextPhase: uint32
    CommandWriteDataSize: uint32
    CommandWriteData: array[1, uint8]
align(1)
struct MTP_COMMAND_DATA_IN
{
    ushort OpCode;
    uint NumParams;
    uint[5] Params;
    uint NextPhase;
    uint CommandWriteDataSize;
    ubyte[1] CommandWriteData;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; MTP_COMMAND_DATA_IN サイズ: 35 バイト(x64)
dim st, 9    ; 4byte整数×9(構造体サイズ 35 / 4 切り上げ)
; OpCode : WORD (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; NumParams : DWORD (+2, 4byte)  lpoke st,2,値  /  値 = lpeek(st,2)
; Params : DWORD (+6, 20byte)  varptr(st)+6 を基点に操作(20byte:入れ子/配列)
; NextPhase : DWORD (+26, 4byte)  lpoke st,26,値  /  値 = lpeek(st,26)
; CommandWriteDataSize : DWORD (+30, 4byte)  lpoke st,30,値  /  値 = lpeek(st,30)
; CommandWriteData : BYTE (+34, 1byte)  varptr(st)+34 を基点に操作(1byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global MTP_COMMAND_DATA_IN, pack=1
    #field short OpCode
    #field int NumParams
    #field int Params 5
    #field int NextPhase
    #field int CommandWriteDataSize
    #field byte CommandWriteData 1
#endstruct

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