DisableNtmsObject 関数 (ntmsapi.h)

  • [アーティクル]

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

DisableNtmsObject 関数は、指定された RSM オブジェクトを無効にします。

構文

DWORD DisableNtmsObject(
  [in] HANDLE      hSession,
  [in] DWORD       dwType,
  [in] LPNTMS_GUID lpObjectId
);

パラメーター

[in] hSession

OpenNtmsSession 関数によって返されるセッションを処理します。

[in] dwType

RSM オブジェクトの種類。 このパラメーターには、 NtmsObjectsTypes 列挙型の次のいずれかの値を指定できます。

値 意味
NTMS_DRIVE
 ドライブ
NTMS_LIBRARY
 ライブラリ
NTMS_PHYSICAL_MEDIA
 物理メディア (テープ、光ディスク、CD、磁気カートリッジ)

[in] lpObjectId

RSM オブジェクトの一意識別子。

戻り値

この関数は、次のいずれかの値を返します。

値 意味
ERROR_ACCESS_DENIED
 オブジェクトを含むライブラリへのNTMS_MODIFY_ACCESSは拒否されます。 その他のセキュリティ エラーが発生する可能性がありますが、セキュリティ サブシステム エラーを示します。

Windows XP: オブジェクトを含むライブラリへのNTMS_CONTROL_ACCESSは拒否されます。 その他のセキュリティ エラーが発生する可能性がありますが、セキュリティ サブシステム エラーを示します。
ERROR_DATABASE_FAILURE
 データベースにアクセスできないか、破損しています。
ERROR_INVALID_HANDLE
 セッション ハンドルがないか、無効です。
ERROR_INVALID_PARAMETER
 オブジェクト ID がないか、オブジェクトの種類が無効です。 (オブジェクト型がNTMS_LIBRARY、NTMS_DRIVE、またはNTMS_PHYSICAL_MEDIAでない場合は無効です)。
ERROR_INVALID_STATE
 オブジェクトは既に無効になっています。
ERROR_LIBRARY_OFFLINE
 ライブラリ ID は、有効または無効にできないオフライン ライブラリを参照します。
ERROR_OBJECT_NOT_FOUND
 オブジェクトが無効です。
ERROR_SUCCESS
 無効はキューに入れられます。

注釈

DisableNtmsObject 関数は、指定したオブジェクトの disable コマンドをキューに入れます。 この関数は、コマンドがキューに入ると正常に返されます。 RSM がビジー状態の場合、コマンドの完了に時間がかかる場合があります。 メディアが無効になっている場合、RSM はメディアの側面をすべてレンダリングし、関連付けられている論理メディアを使用できなくなります。 無効にされたメディアに対するすべての要求でエラーが返されます。

ドライブまたはメディアチェンジャーをサービスから削除するには、ドライブまたはメディアチェンジャーを最初に無効にする必要があります。

無効になっているオブジェクトに含まれるすべてのオブジェクトも無効になります。 たとえば、物理メディアの一部を無効にすると、すべての側面が無効になります。 可能な限り、ドライブを無効にすると、ドライブ内のメディアが取り外され、スロットに配置されます。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー ntmsapi.h
Library Ntmsapi.lib
[DLL] Ntmsapi.dll

こちらもご覧ください

EnableNtmsObject

オブジェクト管理機能