セクション 3(cbl) - COBOL 関数

ドキュメントのダウンロード

サイトマップ

用語集

検索

e-docs > Tuxedo > Tuxedo COBOL リファレンス > セクション 3(cbl) - COBOL 関数

Tuxedo COBOL リファレンス

TPKEYSETINFO(3cbl)

名前

TPKEYSETINFO()－キー・ハンドルに関連付けるオプション・パラメータを設定する

形式

01 TPKEYDEF-REC. 
   COPY TPKEYDEF.

01 ATTVALUE-REC.
   COPY user data

01 TPSTATUS-REC.
   COPY TPSTATUS.

CALL "TPKEYSETINFO" USING TPKEYDEF-REC ATTVALUE-REC TPSTATUS-REC.

機能説明

TPKEYSETINFO() は、キー・ハンドルのオプションの属性パラメータを設定します。キー・ハンドルは、特定のプリンシパルのキーおよびそれに関連付けられている情報を表します。

情報を変更するキーは、TPKEYDEF-REC 内の KEY-HANDLE で識別されます。KEY-HANDLE は、事前の TPKEYOPEN() 呼び出しで返されるキー識別子です。

情報を変更する対象の属性は、TPKEYDEF-REC 内の ATTRIBUTE-NAME で識別されます。属性名には、SPACES または LOW-VALUES を埋め込むことができます。一部の属性は暗号サービス・プロバイダ固有のものですが、TPKEYGETINFO(3cbl) リファレンス・ページで示す基本的属性は、すべてのプロバイダでサポートされる必要があります。

ユーザ定義された ATTVALUE-REC の値は ATTRIBUTE-NAME に関連付けられます。TPKEYSETINFO() が正常に終了すると、ATTVALUE-REC の情報が暗号サービス・プロバイダが定義する方法で格納または処理されます。ATTVALUE-REC のデータの内容が自己記述型の場合、TPKEYDEF-REC 内の ATTRIBUTE-VALUE-LEN は無視されます (0 でかまいません)。それ以外の場合、ATTRIBUTE-VALUE-LEN には ATTVALUE-REC のデータ長を指定する必要があります。

戻り値

TPKEYSETINFO() は正常終了時には、TPSTATUS-REC 内の TP-STATUS に [TPOK] を設定します。

エラー

TPKEYSETINFO() は異常終了時には、TPSTATUS-REC 内の TP-STATUS に次のいずれかの値を設定します。

[TPEINVAL]

無効な引数が指定されました。たとえば、KEY-HANDLE が正しく設定されていません。

[TPESYSTEM]

エラーが発生しました。詳細は、システム・エラーのログ・ファイルを調べてください。

[TPELIMIT]

指定された属性値が大きすぎます。

[TPENOENT]

要求された属性は、キーの暗号サービス・プロバイダによって認識されません。