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。

程式可以改用符號目的名稱來查詢端資訊專案。 若要完成此動作,請將專案編號設定為零。

sym_dest_name
提供的參數。 指定要搜尋的符號目的地名稱。

如果 entry_number 設定為大於零的數位,則會忽略此參數。

side_info_entry
傳回的參數。 指定端資訊專案。 如需端資訊專案的詳細說明,請參閱 Set_CPIC_Side_Information

側邊資訊結構中的每個欄位都會靠左對齊,並在必要時以右邊的空格填補。

side_info_entry_length
提供的參數。 一律為124。

return_code
從此呼叫傳回的程式碼。 本主題稍後會列出有效的傳回碼。

傳回碼

CM_OK
主要傳回碼;呼叫已成功執行。

CM_PROGRAM_PARAMETER_CHECK
主要傳回碼;發生下列其中一種情況:

  • Entry_number指定的數位大於側邊資訊資料表中的專案數上限,或是小於零的數位。

  • Sym_dest_name的參數無效,且entry_number設定為零。

  • Side_info_entry_length參數未設定為124。

    CM_PRODUCT_SPECIFIC_ERROR
    主要傳回碼;發生產品特定的錯誤,並已記錄在 products 錯誤記錄檔中。

狀態變更

此呼叫未與交談相關聯,而且可以是任何狀態。

沒有狀態變更。

備註

安全性密碼永遠不會傳回。 如果未設定端資訊中的安全性使用者識別碼,則會傳回所有空格形式的 [安全性使用者識別碼] 欄位。