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 (状態の変化)

この呼び出しは会話に関連付けられていないので、任意の状態にすることができます。

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

注釈

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