NTMS_OBJECTINFORMATIONA 結構 (ntmsapi.h)

發行項
03/05/2024

[從 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

要取得/設定資訊的裝置或系統控制件類型。這個成員必須設定為下列其中一個值。

值	意義
NTMS_CHANGER	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	媒體集區是媒體的邏輯群組。媒體集區中的所有媒體都必須是相同的媒體類型。 Info 成員是NTMS_MEDIAPOOLINFORMATION結構的指標。
NTMS_MEDIA_TYPE	系統會針對系統中的每個唯一媒體類型建立媒體類型物件。 Info 成員是NTMS_MEDIATYPEINFORMATION結構的指標。
NTMS_OPREQUEST	運算子要求物件代表使用者取得資訊的 RSM 要求。 Info 成員是NTMS_OPREQUESTINFORMATION結構的指標。
NTMS_PARTITION	側邊物件代表實體媒體的一邊。 Info 成員是NTMS_PARTITIONINFORMATION結構的指標。
NTMS_PHYSICAL_MEDIA	實體媒體物件代表磁帶或抽取式磁碟。一段實體媒體可以包含一或多個側邊。 Info 成員是NTMS_PMIDINFORMATION結構的指標。
NTMS_STORAGESLOT	儲存位置物件代表可在連結庫中保存指定媒體的其中一個位置。 Info 成員是NTMS_STORAGESLOTINFORMATION結構的指標。

Created

類型： SYSTEMTIME

建立物件的日期/時間戳。

Modified

類型： SYSTEMTIME

修改物件的日期/時間戳。

ObjectGuid

類型： NTMS_GUID

物件的 GUID。

Enabled

類型： BOOL

指出是否啟用裝置或系統控制物件。

dwOperationalState

類型： DWORD

定義物件的目前作業狀態。這可以是下列其中一個值。

值	意義
NTMS_NOT_PRESENT	此裝置或物件目前不存在。
NTMS_READY	此裝置或物件可供使用且已就緒。
NTMS_NEEDS_SERVICE	此裝置或物件失敗且需要服務。

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 標頭會將NTMS_OBJECTINFORMATION定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限桌面應用程式]
標頭	ntmsapi.h

另請參閱

GetNtmsObjectInformation

SetNtmsObjectInformation

共用方式為

NTMS_OBJECTINFORMATIONA 結構 (ntmsapi.h)

語法

成員

備註

規格需求

另請參閱

意見反應

其他資源