API 関数呼び出し

表 1 に、API 関数呼び出しのアルファベット順リスト、簡単な説明、および関数呼び出しに関する詳細情報の場所を示します。以下の情報が含まれます。

エレメント	説明
目的	関数呼び出しについて説明します。
構文	その関数呼び出しの実際の C コードです。このコードは、UNIX または Linux® バージョンの dsmapifp.h ヘッダー・ファイルからコピーされます。 API 関数定義ソース・ファイル (API function definitions source file)を参照。このファイルは、他のオペレーティング・システムでは少し異なります。他のオペレーティング・システムのアプリケーション・プログラマーは、API 定義が正確な構文になっているかどうか、それぞれのバージョンのヘッダー・ファイル dsmapifp.h をチェックしてください。
パラメーター	関数呼び出しの各パラメーターについて説明します。使用方法に基づいて、入力 (I) または出力 (O) として識別します。パラメーターのなかには、入出力の両方 (I/O) を指定するものもあります。ここで言及するデータ・タイプは、dsmapitd.h ヘッダー・ファイルで定義されています。 API タイプ定義ソース・ファイルを参照してください。
戻りコード	その関数呼び出しに特定の戻りコードのリストです。通信エラー、サーバーの問題、あるいはユーザー・エラーのような一般的なシステム・エラーもあります。これらのエラーはどの呼び出しでも起こりうるものであり、ここには示されていません。戻りコードは dsmrc.h ヘッダー・ファイルで定義されています。 API 戻りコード・ソース・ファイル dsmrc.hを参照してください。

表 1. API 関数呼び出し
関数呼び出しとリンク	説明
dsmBeginGetData	ストレージ内のオブジェクトのリストについて、リストアまたはリトリーブ操作を開始します。
dsmBeginQuery	情報を得るために IBM® Storage Protect への照会要求を開始します。
dsmBeginTxn	完全なアクションを開始する 1 つまたは複数のトランザクションを開始します。すべてのアクションが成功するか、どれも成功しないかのいずれになります。
dsmBindMC	渡されたオブジェクトに管理クラスを関連付け (バインド) ます。
dsmChangePW	IBM Storage Protect パスワードを変更します。
dsmCleanUp	これは、dsmSetUp の呼び出し時に使用されます。
dsmDeleteAccess	オブジェクトのバックアップ・バージョンまたはアーカイブ・コピーのための現行の許可規則を削除します。
dsmDeleteFS	ファイル・スペースをストレージから削除します。
dsmDeleteObj	ストレージ内のバックアップ・オブジェクトをオフにしたり、アーカイブ・オブジェクトを削除したりします。
dsmEndGetData	ストレージからオブジェクトを取得する dsmBeginGetData セッションを終了します。
dsmEndGetDataEx	送信された LAN フリーの合計バイト数を提供します。
dsmEndGetObj	指定されたオブジェクトのデータを取得する dsmGetObj セッションを終了します。
dsmEndQuery	dsmBeginQuery アクションの終了を示します。
dsmEndSendObj	ストレージに送信される「データ終わり」を示します。
dsmEndSendObjEx	圧縮情報と、送信されたバイト数を提供します。
dsmEndTxn	IBM Storage Protect トランザクションを終了します。
dsmEndTxnEx	dsmGroupHandlerfunction 呼び出しで使用するグループ・リーダー・オブジェクト ID 情報を提供します。
dsmGetData	IBM Storage Protect からデータのバイト・ストリームを取得し、それを呼び出し元のバッファーに入れます。
dsmGetBufferData	IBM Storage Protect サーバーから IBM Storage Protect割り振りデータ・バッファーを取得します。
dsmGetNextQObj	前の dsmBeginQuery 呼び出しから次の照会応答を取得し、それを呼び出し元のバッファーに入れます。
dsmGetObj	データ・ストリームから要求されたオブジェクト・データを取得し、それを呼び出し側のバッファーに入れます。
dsmGroupHandler	与えられた入力に応じて、論理ファイル・グループにアクションを実行します。
dsmInit	API セッションを開始し、クライアントをストレージに接続します。
dsmInitEx	拡張検査を許可する追加のパラメーターを使用して、API セッションを開始します。
dsmLogEvent	ユーザー・メッセージを、サーバー・ログ・ファイル、ローカル・エラー・ログ、またはその両方に記録します。
dsmLogEventEx	ユーザー・メッセージを、サーバー・ログ・ファイル、ローカル・エラー・ログ、またはその両方に記録します。
dsmQueryAccess	オブジェクトのバックアップ・バージョンまたはアーカイブ・コピーのためのすべてのアクセス許可規則をサーバーに照会します。
dsmQueryApiVersion	アプリケーション・クライアントによってアクセスされる API ライブラリー・バージョンについて照会要求を実行します。
dsmQueryApiVersionEx	アプリケーション・クライアントによってアクセスされる API ライブラリー・バージョンについて照会要求を実行します。
dsmQueryCliOptions	ユーザーのオプション・ファイル内の重要なオプションの値を照会します。
dsmQuerySessInfo	dsmHandleで指定されたセッションの操作に関連する情報について、 IBM Storage Protect への照会要求を開始します。
dsmQuerySessOptions	dsmHandle の指定したセッション内での有効な重要オプション値を照会します。
dsmRCMsg	API 戻りコードに関連したメッセージ・テキストを取得します。
dsmRegisterFS	サーバーに新規ファイル・スペースを登録します。
dsmReleaseBuffer	IBM Storage Protect割り振りバッファーを戻します。
dsmRenameObj	高位オブジェクト名または低位オブジェクト名を名前変更します。
dsmRequestBuffer	バッファー・コピーを除去するための IBM Storage Protect割り振りバッファーを取得します。
dsmRetentionEvent	オブジェクト ID のリストを、これらのオブジェクトに対して実行される保存イベント操作を指定して、サーバーに送信します。
dsmSendBufferData	IBM Storage Protect割り振りバッファーからデータを送信します。
dsmSendData	バッファーを介してデータのバイト・ストリームを IBM Storage Protect に送信します。
dsmSendObj	ストレージへの単一オブジェクトの送信要求を開始します。
dsmSetAccess	他のユーザー、または他のノードに、オブジェクトのバックアップ・バージョンまたはアーカイブ・コピーへのアクセス、すべてのオブジェクトへのアクセス、または一部の選択したものへのアクセスを許可します。
dsmSetUp	環境変数値を指定変更します。
dsmTerminate	サーバーとのセッションを終了し、 IBM Storage Protect 環境をクリーンアップします。
dsmUpdateFS	ストレージ内のファイル・スペースを更新します。
dsmUpdateObj	既にサーバー上にある活動バックアップ・オブジェクトに関連する objInfo 情報を更新します。または、アーカイブ済みオブジェクトを更新します。
dsmUpdateObjEx	同じ名前を持つ複数のオブジェクトがある場合でも、特定のアーカイブ・オブジェクトに関連する objInfo 情報を更新します。または、活動バックアップ・オブジェクトを更新します。