NTMS_OBJECTINFORMATIONA 構造体 (ntmsapi.h)
[リムーバブル 記憶域マネージャー は、Windows 7 および Windows Server 2008 R2 以降では使用できません。
NTMS_OBJECTINFORMATION構造体は、アプリケーションが RSM デバイス、メディア、およびシステム コントロール (ライブラリ、ドライブ、メディア、オペレーター要求など) に対して取得および設定できるプロパティを定義します。 これは、RSM データベース内のオブジェクトの一般的な構造です。
構文
typedef struct _NTMS_OBJECTINFORMATIONA {
DWORD dwSize;
DWORD dwType;
SYSTEMTIME Created;
SYSTEMTIME Modified;
NTMS_GUID ObjectGuid;
BOOL Enabled;
DWORD dwOperationalState;
CHAR szName[NTMS_OBJECTNAME_LENGTH];
CHAR szDescription[NTMS_DESCRIPTION_LENGTH];
#if ...
union {
NTMS_DRIVEINFORMATIONA Drive;
NTMS_DRIVETYPEINFORMATIONA DriveType;
NTMS_LIBRARYINFORMATION Library;
NTMS_CHANGERINFORMATIONA Changer;
NTMS_CHANGERTYPEINFORMATIONA ChangerType;
NTMS_STORAGESLOTINFORMATION StorageSlot;
NTMS_IEDOORINFORMATION IEDoor;
NTMS_IEPORTINFORMATION IEPort;
NTMS_PMIDINFORMATIONA PhysicalMedia;
NTMS_LMIDINFORMATION LogicalMedia;
NTMS_PARTITIONINFORMATIONA Partition;
NTMS_MEDIAPOOLINFORMATION MediaPool;
NTMS_MEDIATYPEINFORMATION MediaType;
NTMS_LIBREQUESTINFORMATIONA LibRequest;
NTMS_OPREQUESTINFORMATIONA OpRequest;
NTMS_COMPUTERINFORMATION Computer;
} Info;
#else
union {
NTMS_DRIVEINFORMATIONA Drive;
NTMS_DRIVETYPEINFORMATIONA DriveType;
NTMS_LIBRARYINFORMATION Library;
NTMS_CHANGERINFORMATIONA Changer;
NTMS_CHANGERTYPEINFORMATIONA ChangerType;
NTMS_STORAGESLOTINFORMATION StorageSlot;
NTMS_IEDOORINFORMATION IEDoor;
NTMS_IEPORTINFORMATION IEPort;
NTMS_PMIDINFORMATIONA PhysicalMedia;
NTMS_LMIDINFORMATION LogicalMedia;
NTMS_PARTITIONINFORMATIONA Partition;
NTMS_MEDIAPOOLINFORMATION MediaPool;
NTMS_MEDIATYPEINFORMATION MediaType;
NTMS_LIBREQUESTINFORMATIONA LibRequest;
NTMS_OPREQUESTINFORMATIONA OpRequest;
NTMS_COMPUTERINFORMATION Computer;
} Info;
#endif
} NTMS_OBJECTINFORMATIONA, *LPNTMS_OBJECTINFORMATIONA;
メンバー
dwSize
型: DWORD
情報構造のサイズ (バイト単位)。 このメンバーは、GetNtmsObjectInformation 関数または SetNtmsObjectInformation 関数を使用する前に、構造体の正しいサイズに設定する必要があります。
dwType
型: DWORD
情報を取得または設定するデバイスまたはシステム コントロールの種類。 このメンバーは、次のいずれかの値に設定する必要があります。
| 値 | 意味 |
|---|---|
|
チェンジャー オブジェクトは、ライブラリ ユニットのロボット要素を表します。 Info メンバーは、NTMS_CHANGERINFORMATION構造体へのポインターです。 |
|
システムに接続されている一意の変更装置タイプごとに、変更タイプ・オブジェクトが作成されます。 Info メンバーは、NTMS_CHANGERTYPEINFORMATION構造体へのポインターです。 |
|
現在のコンピューター オブジェクト。 コンピューター オブジェクトの構造はありません。 Info メンバーは、NTMS_COMPUTERINFORMATION構造体へのポインターです。 |
|
ドライブ オブジェクトは、テープ ドライブまたはディスク ドライブを表します。 Info メンバーは、NTMS_DRIVEINFORMATION構造体へのポインターです。 |
|
ドライブの種類のオブジェクトは、システムに接続されている一意のドライブ デバイスの種類ごとに作成されます。 Info メンバーは、NTMS_DRIVETYPEINFORMATION構造体へのポインターです。 |
|
NTMS_IEDOOR オブジェクトは、ライブラリ ユニットのドア アクセス メカニズムを表します。 Info メンバーは、NTMS_IEDOORINFORMATION構造体へのポインターです。 |
|
NTMS_IEPORT オブジェクトは、ライブラリ ユニットの挿入/取り出しポートを表します。 Info メンバーは、NTMS_IEPORTINFORMATION構造体へのポインターです。 |
|
ライブラリ オブジェクトは、オンライン ライブラリまたはオフライン ライブラリを表します。 Info メンバーは、NTMS_LIBRARYINFORMATION構造体へのポインターです。 |
|
ライブラリ要求オブジェクトは、アクションを実行するライブラリの要求ごとに作成されます。 ライブラリ要求の一覧は、実行する作業のキューとして RSM によって管理されます。 Info メンバーは、NTMS_LIBREQUESTINFORMATION構造体へのポインターです。 |
|
アプリケーションが指定したメディアにアクセスするために使用するプライマリ ハンドル。 両面メディアの場合、各側は物理メディアの個々の部分として扱われます。 Info メンバーは、NTMS_LMIDINFORMATION構造体へのポインターです。 |
|
メディア プールは、メディアの論理グループです。 メディア プール内のすべてのメディアは、同じメディアの種類である必要があります。 Info メンバーは、NTMS_MEDIAPOOLINFORMATION構造体へのポインターです。 |
|
メディアタイプオブジェクトは、システム内の一意のメディアタイプごとに作成されます。 Info メンバーは、NTMS_MEDIATYPEINFORMATION構造体へのポインターです。 |
|
オペレーター要求オブジェクトは、ユーザーが情報を取得するための RSM 要求を表します。 Info メンバーは、NTMS_OPREQUESTINFORMATION構造体へのポインターです。 |
|
サイド オブジェクトは、物理メディアの一部の側面を表します。 Info メンバーは、NTMS_PARTITIONINFORMATION構造体へのポインターです。 |
|
物理メディア オブジェクトは、磁気テープまたはリムーバブル ディスクを表します。 物理メディアの一部には、1 つ以上の辺を含めることができます。 Info メンバーは、NTMS_PMIDINFORMATION構造体へのポインターです。 |
|
ストレージ スロット オブジェクトは、ライブラリ内の指定されたメディアを保持できるスロットの 1 つを表します。 Info メンバーは、NTMS_STORAGESLOTINFORMATION構造体へのポインターです。 |
Created
種類: SYSTEMTIME
オブジェクトが作成されたときの日付/時刻スタンプ。
Modified
種類: SYSTEMTIME
オブジェクトが変更されたときの日付/タイム スタンプ。
ObjectGuid
種類: NTMS_GUID
オブジェクトの GUID。
Enabled
種類: BOOL
デバイスコントロールオブジェクトとシステムコントロールオブジェクトのどちらを有効にするかを示します。
dwOperationalState
型: DWORD
オブジェクトの現在の操作状態を定義します。 これには、次のいずれかの値を指定できます。
| 値 | 意味 |
|---|---|
|
このデバイスまたはオブジェクトは現在存在しません。 |
|
このデバイスまたはオブジェクトは使用でき、準備ができています。 |
|
このデバイスまたはオブジェクトは失敗し、サービスが必要です。 |
szName[NTMS_OBJECTNAME_LENGTH]
種類: TCHAR[NTMS_OBJECTNAME_LENGTH]
メディア、デバイス、またはシステム コントロール オブジェクトの名前。 メディア プールと論理メディア名は 、SetNtmsObjectInformation 関数を使用して変更できます。 その他のオブジェクト名はすべて読み取り専用です。
szDescription[NTMS_DESCRIPTION_LENGTH]
種類: TCHAR[NTMS_DESCRIPTION_LENGTH]
デバイスまたはシステム制御オブジェクトの説明。 デバイスおよびシステム制御オブジェクトの説明は、 SetNtmsObjectInformation 関数を使用して変更できます。 (すべてのオブジェクトに対して書き込み可能)
Info
デバイスまたはシステム コントロールのオブジェクト固有の情報。 この情報の形式は dwType メンバーによって異なります。
Info.Drive
種類: NTMS_DRIVEINFORMATION この形式は、 dwType 値が NTMS_DRIVE場合に使用されます。
Info.DriveType
種類: NTMS_DRIVETYPEINFORMATION この形式は、 dwType 値が NTMS_DRIVE_TYPE場合に使用されます。
Info.Library
種類: NTMS_LIBRARYINFORMATION この形式は、 dwType 値がNTMS_LIBRARY場合 に使用されます。
Info.Changer
種類: NTMS_CHANGERINFORMATION この形式は、 dwType 値が NTMS_CHANGER場合に使用されます。
Info.ChangerType
種類: NTMS_CHANGERTYPEINFORMATION この形式は、 dwType 値が NTMS_CHANGER_TYPE場合に使用されます。
Info.StorageSlot
種類: NTMS_STORAGESLOTINFORMATION この形式は、 dwType 値が NTMS_STORAGESLOT場合に使用されます。
Info.IEDoor
種類: NTMS_IEDOORINFORMATION この形式は、 dwType 値が NTMS_IEDOOR場合に使用されます。
Info.IEPort
種類: NTMS_IEPORTINFORMATION この形式は、 dwType 値がNTMS_IEPORT場合 に使用されます。
Info.PhysicalMedia
種類: NTMS_PMIDINFORMATION この形式は、 dwType 値がNTMS_PHYSICAL_MEDIA場合 に使用されます。
Info.LogicalMedia
種類: NTMS_LMIDINFORMATION この形式は、 dwType 値が NTMS_LOGICAL_MEDIA場合に使用されます。
Info.Partition
種類: NTMS_PARTITIONINFORMATION この形式は、 dwType 値が NTMS_PARTITION場合に使用されます。
Info.MediaPool
種類: NTMS_MEDIAPOOLINFORMATION この形式は、 dwType 値が NTMS_MEDIA_POOL場合に使用されます。
Info.MediaType
種類: NTMS_MEDIATYPEINFORMATION この形式は、 dwType 値がNTMS_MEDIA_TYPE場合 に使用されます。
Info.LibRequest
種類: NTMS_LIBREQUESTINFORMATION この形式は、 dwType 値がNTMS_LIBREQUEST場合 に使用されます。
Info.OpRequest
種類: NTMS_OPREQUESTINFORMATION この形式は、 dwType 値がNTMS_OPREQUEST場合 に使用されます。
Info.Computer
注釈
メンバーの定義で WRITABLE として指定されていない限り、 NTMS_OBJECTINFORMATION 構造体のすべてのメンバーは RSM 関数レベルで読み取り専用です。
注意
ntmsapi.h ヘッダーは、unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとしてNTMS_OBJECTINFORMATIONを定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| Header | ntmsapi.h |