SetNtmsUIOptionsA 関数 (ntmsapi.h)

  • [アーティクル]

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

SetNtmsUIOptions 関数は、指定した種類の UI が指定されたオブジェクトに対して送信されるコンピューター名の一覧を変更します。

構文

DWORD SetNtmsUIOptionsA(
  [in]  HANDLE            hSession,
  [in]  const LPNTMS_GUID lpObjectId,
  [in]  DWORD             dwType,
  [in]  DWORD             dwOperation,
  [out] LPCSTR            lpszDestination
);

パラメーター

[in] hSession

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

[in] lpObjectId

UI がリダイレクトされるオブジェクトの一意識別子。 オブジェクトは、イベントのソースとなるコンテナーである必要があります。 オブジェクトは、アプリケーション (アプリケーションによってトリガーされるマウント要求)、ライブラリ (取り出しに応じてドアを開く要求)、またはコンピューター (コンピューターに関連するすべての UI) のいずれかです。

コンピューター コンテナーを指定するには、 lpObjectId ポインターを、リムーバブル 記憶域マネージャーのコンピューター オブジェクト GUID を持つバッファーを指すよう設定します。 特定のライブラリを指定するには、ライブラリの GUID を持つバッファーを指すよう設定します。 アプリケーションを指定するには、 NULL ポインターを渡します。 アプリケーションの ID は、 hSession で使用されるセッションによって決まります。 1 つのアプリケーションで複数のセッションを同時に開くことができることに注意してください。 この場合、値セットは hSession セッションにのみ適用されます。 ライブラリまたはコンピューター インスタンスの場合、設定は明示的に変更されるまで保持されます。 セッションが閉じられると、アプリケーション行が削除されます。

[in] dwType

このパラメーターには、次のいずれかの値を指定できます。

値 意味
NTMS_UITYPE_INFO
 情報を提供する UI メッセージ。 これには、進行状況を示す作業キュー項目が含まれます。 たとえば、要求をマウントします。
NTMS_UITYPE_REQ
 要求である UI メッセージ。 これには、メディアを処理するオペレーター要求が含まれます。 たとえば、新しいメディアを挿入する要求です。
NTMS_UITYPE_ERR
 エラー情報を提供する UI メッセージ。 これには、エラー通知に関連する演算子要求が含まれます。 たとえば、ドライブをクリーンする要求などです。

[in] dwOperation

このパラメーターには、次のいずれかの値を指定できます。

値 意味
NTMS_UIDEST_ADD
 新しい宛先 (コンピューター名) を一覧に追加します。
NTMS_UIDEST_DELETE
 リストから宛先を削除します。
NTMS_UIDEST_DELETEALL
 一覧からすべての宛先をクリアします。 オブジェクトの UI は生成されません。 この場合、変換先の引数は無視されます。

[out] lpszDestination

UI がリダイレクトされるコンピューターの名前を返す複数文字列。 このパラメーターを NULL にすることはできません。

戻り値

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

値 意味
ERROR_ACCESS_DENIED
 1 つ以上の RSM オブジェクトへのアクセスは拒否されます。
ERROR_ALREADY_EXISTS
 指定された宛先がリストに既に存在します。
ERROR_INVALID_HANDLE
 セッション ハンドルがないか、無効です。
ERROR_INVALID_PARAMETER
 lpdwSize または lpszDestination ポインターが NULL であるか、 lpObjectId が有効なコンテナーではないか、 dwType または dwOperation が 3 つの有効な値の 1 つではありません。
ERROR_NOT_ENOUGH_MEMORY
 処理中に割り当てエラーが発生しました。
ERROR_OBJECT_NOT_FOUND
 lpObjectId で指定された GUID は、データベース内のコンピューターまたはライブラリ オブジェクトの GUID ではありません。
ERROR_SUCCESS
 関数は成功しました。

注釈

SetNtmsUIOptions を呼び出すと、lpObjectId パラメーターと dwType パラメーターによって決定された特定のインスタンスの宛先が追加または削除されます。

  NTMS_UITYPE_INFO NTMS_UITYPE_REQ NTMS_UITYPE_ERR
アプリケーション このアプリケーションによって生成された作業項目の作業項目の進行状況 UI を表示します。 このアプリケーションによって実行されたアクションによって生成されたオペレーター要求のオペレーター要求 UI を表示します。 未定義です。 アプリケーションでは、この種のエラー イベントを発生させることはできません。
ライブラリ このライブラリに関連付けられている作業項目の作業項目の進行状況 UI を表示します。 このライブラリに関連付けられている要求の UI を表示します。 このライブラリに関連付けられているエラーの UI を表示します。
Computer このマシンで実行されている RSM のこのインスタンスに情報 UI を表示します。 RSM のこのインスタンスに要求の種類の UI を表示します。 RSM のこのインスタンスにエラーの種類の UI を表示します。
 

セキュリティ チェックは 、SetNtmsUIOptions を呼び出すときに実行されることに注意してください。 コンピューター オブジェクトが指定されている場合は、コンピューターを変更するアクセス許可を持つアクセス権が必要です。 ライブラリの UI 要素を変更する場合は、ライブラリ オブジェクトを変更するアクセス許可を持つアクセス許可が必要です。

宛先文字列のチェックは行われません。 SetNtmsUIOptions が呼び出されたコンピューターから到達可能なコンピューターではない宛先名を持つ への呼び出しは成功を返します。 空の文字列へのポインターは、ローカル コンピューターを意味するために取得されます。

注意

ntmsapi.h ヘッダーは、SetNtmsUIOptions をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

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

こちらもご覧ください

GetNtmsUIOptions

ライブラリ コントロール関数