comm_status屬性

[comm_status] ACF 屬性會在函式執行期間發生通訊錯誤時傳回錯誤碼。

[comm_status [ , ACF-function-attributes ] ] 
    error_status_t function-name(
        [ [ ACF-parameter-attributes ] ] parameter-name
        , ...);

[ [ ACF-function-attributes ] ] function-name(
    [comm_status [ , ACF-parameter-attributes ] ] error_status_t name
    , ...);

參數

ACF-function-attributes

指定零個或多個 ACF 函式屬性,例如[comm_status][nocode]。 函式屬性會以方括弧括住。 零個或多個屬性可以套用至函式。 以逗號分隔多個函式屬性。 請注意,如果 [comm_status] 顯示為函式屬性,它也無法顯示為參數屬性。

function-name

指定 IDL 檔案中所定義的函式名稱。

ACF-parameter-attributes

指定套用至參數的屬性。 請注意,零、一或多個屬性可以套用至 參數。 以逗號分隔多個參數屬性。 參數屬性會以方括弧括住。 ACF 中不允許 IDL 參數屬性,例如方向屬性。 請注意,如果 [comm_status] 顯示為參數屬性,它也無法顯示為函式屬性。

parameter-name

指定 IDL 檔案中所定義之函式的參數。 函式的每個參數都必須以相同的順序指定,並使用與 IDL 檔案中所定義的相同名稱。

備註

[comm_status]屬性可以當做函式屬性或參數屬性使用,但每個函式只能顯示一次。 它可以套用至函式或每個函式中的一個參數。

[comm_status]屬性只能套用至傳回類型error_status_t的函式。 在函式執行期間發生通訊錯誤時,會傳回錯誤碼。

當 [comm_status]當做參數屬性使用時,參數必須在 IDL 檔案中定義,而且必須是類型error_status_t[out]參數。 在函式執行期間發生通訊錯誤時,參數會設定為錯誤碼。 成功完成遠端呼叫時,程式會設定值。

[comm_status][fault_status]屬性都可能會以函式屬性或參數屬性的形式出現在單一函式中。 如果這兩個屬性都是函式屬性,或它們套用至相同的參數,而且不會發生任何錯誤,則函式或參數的值 error_status_ok。 否則,它包含適當的 [comm_status][fault_status] 值。 由於 針對 [comm_status] 傳回的值與 [ fault_status]傳回的值不同,因此會立即解譯傳回的值。

另請參閱

應用程式組態檔 (ACF)

error_status_t

fault_status

nocode

out