Extract_CPIC_Side_Information (CPI-C)

Extract_CPIC_Side_Information 呼び出し (関数名 xcmesi) は、エントリ番号またはシンボリック変換先名の側の情報を返します。

構文

  
CM_ENTRY Extract_CPIC_Side_Information(   
  CM_INT32 FAR *entry_number,          
  unsigned char FAR *sym_dest_name,    
  SIDE_INFO FAR *side_info_entry,      
  CM_INT32 FAR *side_info_entry_length,    
    CM_INT32 FAR *return_code            
);  

パラメーター

entry_number
指定されたパラメーター。 返されるサイド情報エントリの数 (インデックス) を指定します。 最初のエントリは 1 です。

プログラムは、代わりにシンボリック変換先名でサイド情報エントリを検索できます。 これを行うには、エントリ番号を 0 に設定します。

sym_dest_name
指定されたパラメーター。 検索するシンボリック変換先の名前を指定します。

entry_number 0 より大きい数値に設定されている場合、このパラメーターは無視されます。

side_info_entry
返されたパラメーター。 サイド情報エントリを指定します。 サイド情報エントリの詳細については、「サイド 情報」を参照Set_CPIC_Side_Information。

サイド情報構造の各フィールドは左揃えで、必要に応じて右側にスペースが埋め込まれます。

side_info_entry_length
指定されたパラメーター。 常に 124。

return_code
この呼び出しから返されるコード。 有効なリターン コードについては、このトピックの後半で説明します。

リターン コード

CM_OK
プライマリ リターン コード。呼び出しが正常に実行されました。

CM_PROGRAM_PARAMETER_CHECK
プライマリ リターン コード。次のいずれかのエラーが発生しました。

  • この entry_number 、サイド情報テーブル内のエントリの最大数より大きい数値、または 0 未満の数値を指定しました。

  • パラメーター sym_dest_name 無効 であり、entry_number 0 に設定されています。

  • パラメーター side_info_entry_length 124 に設定されていない。

    CM_PRODUCT_SPECIFIC_ERROR
    プライマリ リターン コード。製品固有のエラーが発生し、製品エラー ログに記録されています。

State Changes (状態の変化)

この呼び出しは、会話に関連付けられているのではなく、任意の状態である可能性があります。

状態の変更はありません。

解説

セキュリティ パスワードは返されません。 サイド情報のセキュリティ ユーザー識別子が設定されていない場合、セキュリティ ユーザー識別子フィールドは、すべてのスペースとして返されます。