Win32 API 日本語リファレンス
ホームStorage.FileSystem › NTMS_OBJECTINFORMATIONA

NTMS_OBJECTINFORMATIONA

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

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

フィールド

フィールドサイズx64x86説明
dwSizeDWORD4+0+0情報構造体のサイズ (バイト単位)。このメンバーは、 GetNtmsObjectInformation 関数または SetNtmsObjectInformation 関数を使用する前に、構造体の正しいサイズに設定しておく必要があります。
dwTypeDWORD4+4+4

情報を取得または設定する対象のデバイスまたはシステム制御の種類。このメンバーは、次のいずれかの値に設定する必要があります。

意味
NTMS_CHANGER
チェンジャー オブジェクトは、ライブラリ ユニットのロボット要素を表します。Info メンバーは NTMS_CHANGERINFORMATION 構造体へのポインターです。
NTMS_CHANGER_TYPE
チェンジャー種類オブジェクトは、システムに接続されている固有のチェンジャー デバイスの種類ごとに作成されます。Info メンバーは NTMS_CHANGERTYPEINFORMATION 構造体へのポインターです。
NTMS_COMPUTER
現在のコンピューター オブジェクトです。コンピューター オブジェクト用の構造体はありません。Info メンバーは NTMS_COMPUTERINFORMATION 構造体へのポインターです。
NTMS_DRIVE
ドライブ オブジェクトは、テープ ドライブまたはディスク ドライブを表します。Info メンバーは NTMS_DRIVEINFORMATION 構造体へのポインターです。
NTMS_DRIVE_TYPE
ドライブ種類オブジェクトは、システムに接続されている固有のドライブ デバイスの種類ごとに作成されます。Info メンバーは NTMS_DRIVETYPEINFORMATION 構造体へのポインターです。
NTMS_IEDOOR
NTMS_IEDOOR オブジェクトは、ライブラリ ユニットのドア アクセス機構を表します。Info メンバーは NTMS_IEDOORINFORMATION 構造体へのポインターです。
NTMS_IEPORT
NTMS_IEPORT オブジェクトは、ライブラリ ユニットの挿入/排出ポートを表します。Info メンバーは NTMS_IEPORTINFORMATION 構造体へのポインターです。
NTMS_LIBRARY
ライブラリ オブジェクトは、オンラインまたはオフラインのライブラリを表します。Info メンバーは NTMS_LIBRARYINFORMATION 構造体へのポインターです。
NTMS_LIBREQUEST
ライブラリ要求オブジェクトは、ライブラリに動作を実行させる要求ごとに作成されます。ライブラリ要求の一覧は、実行すべき作業のキューとして RSM によって管理されます。Info メンバーは NTMS_LIBREQUESTINFORMATION 構造体へのポインターです。
NTMS_LOGICAL_MEDIA
アプリケーションが指定のメディアにアクセスするために使用する主要なハンドルです。両面メディアの場合、各面は個別の物理メディアとして扱われます。Info メンバーは NTMS_LMIDINFORMATION 構造体へのポインターです。
NTMS_MEDIA_POOL
メディア プールは、メディアの論理的なグループです。1 つのメディア プール内のすべてのメディアは、同じメディアの種類でなければなりません。Info メンバーは NTMS_MEDIAPOOLINFORMATION 構造体へのポインターです。
NTMS_MEDIA_TYPE
メディア種類オブジェクトは、システム内の固有のメディアの種類ごとに作成されます。Info メンバーは NTMS_MEDIATYPEINFORMATION 構造体へのポインターです。
NTMS_OPREQUEST
オペレーター要求オブジェクトは、ユーザーに情報の取得を求める RSM の要求を表します。Info メンバーは NTMS_OPREQUESTINFORMATION 構造体へのポインターです。
NTMS_PARTITION
サイド オブジェクトは、物理メディアの 1 つの面を表します。Info メンバーは NTMS_PARTITIONINFORMATION 構造体へのポインターです。
NTMS_PHYSICAL_MEDIA
物理メディア オブジェクトは、磁気テープまたはリムーバブル ディスクを表します。1 つの物理メディアは 1 つ以上の面を持つことができます。Info メンバーは NTMS_PMIDINFORMATION 構造体へのポインターです。
NTMS_STORAGESLOT
記憶域スロット オブジェクトは、ライブラリ内で指定のメディアを保持できるスロットの 1 つを表します。Info メンバーは NTMS_STORAGESLOTINFORMATION 構造体へのポインターです。
CreatedSYSTEMTIME16+8+8オブジェクトが作成された日時のタイム スタンプ。
ModifiedSYSTEMTIME16+24+24オブジェクトが変更された日時のタイム スタンプ。
ObjectGuidGUID16+40+40オブジェクトの GUID。
EnabledBOOL4+56+56デバイスまたはシステム制御オブジェクトが有効かどうかを示します。
dwOperationalStateDWORD4+60+60

オブジェクトの現在の動作状態を定義します。次のいずれかの値になります。

意味
NTMS_NOT_PRESENT
このデバイスまたはオブジェクトは現在存在しません。
NTMS_READY
このデバイスまたはオブジェクトは利用可能で、準備ができています。
NTMS_NEEDS_SERVICE
このデバイスまたはオブジェクトは障害が発生しており、保守が必要です。
szNameCHAR64+64+64メディア、デバイス、またはシステム制御オブジェクトの名前。メディア プール名および論理メディア名は SetNtmsObjectInformation 関数で変更できます。それ以外のオブジェクト名は読み取り専用です。
szDescriptionCHAR127+128+128デバイスまたはシステム制御オブジェクトの説明。デバイスおよびシステム制御オブジェクトの説明は SetNtmsObjectInformation 関数で変更できます。(すべてのオブジェクトで書き込み可能)
Info_Info_e__Union640+256+256デバイスまたはシステム制御オブジェクトに固有の情報。この情報の形式は dwType メンバーによって決まります。

共用体: _Info_e__Union x64 640B / x86 640B

フィールドサイズx64x86説明
DriveNTMS_DRIVEINFORMATIONA232+0+0この形式は、dwType の値が NTMS_DRIVE の場合に使用されます。
DriveTypeNTMS_DRIVETYPEINFORMATIONA264+0+0この形式は、dwType の値が NTMS_DRIVE_TYPE の場合に使用されます。
LibraryNTMS_LIBRARYINFORMATION128+0+0この形式は、dwType の値が NTMS_LIBRARY の場合に使用されます。
ChangerNTMS_CHANGERINFORMATIONA172+0+0この形式は、dwType の値が NTMS_CHANGER の場合に使用されます。
ChangerTypeNTMS_CHANGERTYPEINFORMATIONA260+0+0この形式は、dwType の値が NTMS_CHANGER_TYPE の場合に使用されます。
StorageSlotNTMS_STORAGESLOTINFORMATION24+0+0この形式は、dwType の値が NTMS_STORAGESLOT の場合に使用されます。
IEDoorNTMS_IEDOORINFORMATION28+0+0この形式は、dwType の値が NTMS_IEDOOR の場合に使用されます。
IEPortNTMS_IEPORTINFORMATION32+0+0この形式は、dwType の値が NTMS_IEPORT の場合に使用されます。
PhysicalMediaNTMS_PMIDINFORMATIONA216+0+0この形式は、dwType の値が NTMS_PHYSICAL_MEDIA の場合に使用されます。
LogicalMediaNTMS_LMIDINFORMATION20+0+0この形式は、dwType の値が NTMS_LOGICAL_MEDIA の場合に使用されます。
PartitionNTMS_PARTITIONINFORMATIONA640+0+0この形式は、dwType の値が NTMS_PARTITION の場合に使用されます。
MediaPoolNTMS_MEDIAPOOLINFORMATION60+0+0この形式は、dwType の値が NTMS_MEDIA_POOL の場合に使用されます。
MediaTypeNTMS_MEDIATYPEINFORMATION16+0+0この形式は、dwType の値が NTMS_MEDIA_TYPE の場合に使用されます。
LibRequestNTMS_LIBREQUESTINFORMATIONA340+0+0この形式は、dwType の値が NTMS_LIBREQUEST の場合に使用されます。
OpRequestNTMS_OPREQUESTINFORMATIONA512+0+0この形式は、dwType の値が NTMS_OPREQUEST の場合に使用されます。
ComputerNTMS_COMPUTERINFORMATION20+0+0

公式ドキュメント

[リムーバブル記憶域マネージャー は、Windows 7 および Windows Server 2008 R2 以降では利用できません。]

NTMS_OBJECTINFORMATION 構造体は、RSM のデバイス、メディア、システム制御 (ライブラリ、ドライブ、メディア、オペレーター要求など) に対してアプリケーションが取得および設定できるプロパティを定義します。これは RSM データベース内のオブジェクトに共通の構造体です。

解説(Remarks)

NTMS_OBJECTINFORMATION 構造体のすべてのメンバーは、メンバーの定義で WRITABLE と明記されていない限り、RSM の関数レベルでは読み取り専用です。

メモ

ntmsapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして NTMS_OBJECTINFORMATION を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じてコンパイル エラーや実行時エラーの原因になることがあります。詳細については、関数プロトタイプの規則 を参照してください。

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

各言語での定義

#include <windows.h>

// SYSTEMTIME  (x64 16 / x86 16 バイト)
typedef struct SYSTEMTIME {
    WORD wYear;
    WORD wMonth;
    WORD wDayOfWeek;
    WORD wDay;
    WORD wHour;
    WORD wMinute;
    WORD wSecond;
    WORD wMilliseconds;
} SYSTEMTIME;

// NTMS_OBJECTINFORMATIONA  (x64 896 / x86 896 バイト)
typedef struct NTMS_OBJECTINFORMATIONA {
    DWORD dwSize;
    DWORD dwType;
    SYSTEMTIME Created;
    SYSTEMTIME Modified;
    GUID ObjectGuid;
    BOOL Enabled;
    DWORD dwOperationalState;
    CHAR szName[64];
    CHAR szDescription[127];
    _Info_e__Union Info;
} NTMS_OBJECTINFORMATIONA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SYSTEMTIME
{
    public ushort wYear;
    public ushort wMonth;
    public ushort wDayOfWeek;
    public ushort wDay;
    public ushort wHour;
    public ushort wMinute;
    public ushort wSecond;
    public ushort wMilliseconds;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct NTMS_OBJECTINFORMATIONA
{
    public uint dwSize;
    public uint dwType;
    public SYSTEMTIME Created;
    public SYSTEMTIME Modified;
    public Guid ObjectGuid;
    [MarshalAs(UnmanagedType.Bool)] public bool Enabled;
    public uint dwOperationalState;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 64)] public sbyte[] szName;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 127)] public sbyte[] szDescription;
    public _Info_e__Union Info;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SYSTEMTIME
    Public wYear As UShort
    Public wMonth As UShort
    Public wDayOfWeek As UShort
    Public wDay As UShort
    Public wHour As UShort
    Public wMinute As UShort
    Public wSecond As UShort
    Public wMilliseconds As UShort
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure NTMS_OBJECTINFORMATIONA
    Public dwSize As UInteger
    Public dwType As UInteger
    Public Created As SYSTEMTIME
    Public Modified As SYSTEMTIME
    Public ObjectGuid As Guid
    <MarshalAs(UnmanagedType.Bool)> Public Enabled As Boolean
    Public dwOperationalState As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=64)> Public szName() As SByte
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=127)> Public szDescription() As SByte
    Public Info As _Info_e__Union
End Structure
import ctypes
from ctypes import wintypes

class SYSTEMTIME(ctypes.Structure):
    _fields_ = [
        ("wYear", ctypes.c_ushort),
        ("wMonth", ctypes.c_ushort),
        ("wDayOfWeek", ctypes.c_ushort),
        ("wDay", ctypes.c_ushort),
        ("wHour", ctypes.c_ushort),
        ("wMinute", ctypes.c_ushort),
        ("wSecond", ctypes.c_ushort),
        ("wMilliseconds", ctypes.c_ushort),
    ]

class NTMS_OBJECTINFORMATIONA(ctypes.Structure):
    _fields_ = [
        ("dwSize", wintypes.DWORD),
        ("dwType", wintypes.DWORD),
        ("Created", SYSTEMTIME),
        ("Modified", SYSTEMTIME),
        ("ObjectGuid", GUID),
        ("Enabled", wintypes.BOOL),
        ("dwOperationalState", wintypes.DWORD),
        ("szName", ctypes.c_byte * 64),
        ("szDescription", ctypes.c_byte * 127),
        ("Info", _Info_e__Union),
    ]
#[repr(C)]
pub struct SYSTEMTIME {
    pub wYear: u16,
    pub wMonth: u16,
    pub wDayOfWeek: u16,
    pub wDay: u16,
    pub wHour: u16,
    pub wMinute: u16,
    pub wSecond: u16,
    pub wMilliseconds: u16,
}

#[repr(C)]
pub struct NTMS_OBJECTINFORMATIONA {
    pub dwSize: u32,
    pub dwType: u32,
    pub Created: SYSTEMTIME,
    pub Modified: SYSTEMTIME,
    pub ObjectGuid: GUID,
    pub Enabled: i32,
    pub dwOperationalState: u32,
    pub szName: [i8; 64],
    pub szDescription: [i8; 127],
    pub Info: _Info_e__Union,
}
import "golang.org/x/sys/windows"

type SYSTEMTIME struct {
	wYear uint16
	wMonth uint16
	wDayOfWeek uint16
	wDay uint16
	wHour uint16
	wMinute uint16
	wSecond uint16
	wMilliseconds uint16
}

type NTMS_OBJECTINFORMATIONA struct {
	dwSize uint32
	dwType uint32
	Created SYSTEMTIME
	Modified SYSTEMTIME
	ObjectGuid windows.GUID
	Enabled int32
	dwOperationalState uint32
	szName [64]int8
	szDescription [127]int8
	Info _Info_e__Union
}
type
  SYSTEMTIME = record
    wYear: Word;
    wMonth: Word;
    wDayOfWeek: Word;
    wDay: Word;
    wHour: Word;
    wMinute: Word;
    wSecond: Word;
    wMilliseconds: Word;
  end;

  NTMS_OBJECTINFORMATIONA = record
    dwSize: DWORD;
    dwType: DWORD;
    Created: SYSTEMTIME;
    Modified: SYSTEMTIME;
    ObjectGuid: TGUID;
    Enabled: BOOL;
    dwOperationalState: DWORD;
    szName: array[0..63] of Shortint;
    szDescription: array[0..126] of Shortint;
    Info: _Info_e__Union;
  end;
const SYSTEMTIME = extern struct {
    wYear: u16,
    wMonth: u16,
    wDayOfWeek: u16,
    wDay: u16,
    wHour: u16,
    wMinute: u16,
    wSecond: u16,
    wMilliseconds: u16,
};

const NTMS_OBJECTINFORMATIONA = extern struct {
    dwSize: u32,
    dwType: u32,
    Created: SYSTEMTIME,
    Modified: SYSTEMTIME,
    ObjectGuid: GUID,
    Enabled: i32,
    dwOperationalState: u32,
    szName: [64]i8,
    szDescription: [127]i8,
    Info: _Info_e__Union,
};
type
  SYSTEMTIME {.bycopy.} = object
    wYear: uint16
    wMonth: uint16
    wDayOfWeek: uint16
    wDay: uint16
    wHour: uint16
    wMinute: uint16
    wSecond: uint16
    wMilliseconds: uint16

  NTMS_OBJECTINFORMATIONA {.bycopy.} = object
    dwSize: uint32
    dwType: uint32
    Created: SYSTEMTIME
    Modified: SYSTEMTIME
    ObjectGuid: GUID
    Enabled: int32
    dwOperationalState: uint32
    szName: array[64, int8]
    szDescription: array[127, int8]
    Info: _Info_e__Union
struct SYSTEMTIME
{
    ushort wYear;
    ushort wMonth;
    ushort wDayOfWeek;
    ushort wDay;
    ushort wHour;
    ushort wMinute;
    ushort wSecond;
    ushort wMilliseconds;
}

struct NTMS_OBJECTINFORMATIONA
{
    uint dwSize;
    uint dwType;
    SYSTEMTIME Created;
    SYSTEMTIME Modified;
    GUID ObjectGuid;
    int Enabled;
    uint dwOperationalState;
    byte[64] szName;
    byte[127] szDescription;
    _Info_e__Union Info;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; NTMS_OBJECTINFORMATIONA サイズ: 896 バイト(x64)
dim st, 224    ; 4byte整数×224(構造体サイズ 896 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwType : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Created : SYSTEMTIME (+8, 16byte)  varptr(st)+8 を基点に操作(16byte:入れ子/配列)
; Modified : SYSTEMTIME (+24, 16byte)  varptr(st)+24 を基点に操作(16byte:入れ子/配列)
; ObjectGuid : GUID (+40, 16byte)  varptr(st)+40 を基点に操作(16byte:入れ子/配列)
; Enabled : BOOL (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; dwOperationalState : DWORD (+60, 4byte)  st.15 = 値  /  値 = st.15   (lpoke/lpeek も可)
; szName : CHAR (+64, 64byte)  varptr(st)+64 を基点に操作(64byte:入れ子/配列)
; szDescription : CHAR (+128, 127byte)  varptr(st)+128 を基点に操作(127byte:入れ子/配列)
; Info : _Info_e__Union (+256, 640byte)  varptr(st)+256 を基点に操作(640byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global SYSTEMTIME
    #field short wYear
    #field short wMonth
    #field short wDayOfWeek
    #field short wDay
    #field short wHour
    #field short wMinute
    #field short wSecond
    #field short wMilliseconds
#endstruct

#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global NTMS_OBJECTINFORMATIONA
    #field int dwSize
    #field int dwType
    #field SYSTEMTIME Created
    #field SYSTEMTIME Modified
    #field GUID ObjectGuid
    #field bool Enabled
    #field int dwOperationalState
    #field byte szName 64
    #field byte szDescription 127
    #field byte Info 640
#endstruct

stdim st, NTMS_OBJECTINFORMATIONA        ; NSTRUCT 変数を確保
st->dwSize = 100
mes "dwSize=" + st->dwSize
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。