Set_Mode_Name呼叫 (函式名稱 cmsmn) 是由叫用程式發出,以指定交談的模式名稱。 當發出 Initialize_Conversation 呼叫時,此呼叫會覆寫衍生自側資訊的系統定義模式名稱。 發出 [配置] 之後,便無法發出此呼叫。 發出此呼叫不會影響側邊資訊本身。
語法
CM_ENTRY Set_Mode_Name(
unsigned char FAR *conversation_ID,
unsigned char FAR *mode_name,
CM_INT32 FAR *mode_name_length,
CM_INT32 FAR *return_code
);
參數
conversation_ID
提供的參數。 指定交談的標識碼。 此參數的值是由 Initialize_Conversation 所傳回。
mode_name
提供的參數。 指定模式名稱的起始位址(組態期間定義的一組網路特性名稱)。 模式名稱最多可以包含八個 ASCII 字元。 允許的字元為:
大寫字母。
數位從 0 到 9。
mode_name的值必須符合設定期間與夥伴邏輯單元 (LU) 相關聯的模式名稱。 模式名稱不可以是 SNASVCMG 或 CPSVCMG。
mode_name_length
提供的參數。 指定模式名稱的長度。 範圍是從 0 到 8 個字節。如果 mode_name_length 設為零,則會忽略 Set_Mode_Name 。
return_code
從這個呼叫傳回的程序代碼。 本主題稍後會列出有效的傳回碼。
回傳代碼
CM_OK
主要傳回碼;已成功執行的呼叫。
CM_PROGRAM_STATE_CHECK
主要傳回碼;交談不是處於 INITIALIZE 狀態。
CM_PROGRAM_PARAMETER_CHECK
主要傳回碼;發生下列其中一項:
conversation_ID指定的值無效。
mode_name_length指定的值超出範圍(大於8或小於0)。
CM_PRODUCT_SPECIFIC_ERROR
主要傳回碼;發生產品特定的錯誤,且已在產品錯誤記錄檔中記錄。
狀態變更
交談必須處於 INITIALIZE 狀態。
沒有狀態變更。
備註
在發出 [配置] 之前,不會偵測到指定無效值mode_name。