атрибут comm_status

Атрибут ACF [comm_status] приводит к возврату кода ошибки при возникновении ошибки связи во время выполнения функции.

[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

Указывает ноль или несколько атрибутов функции ACF, таких как [comm_status] и [nocode]. Атрибуты функции заключаются в квадратные скобки. К функции можно применить ноль или несколько атрибутов. Разделяйте несколько атрибутов функции запятыми. Обратите внимание, что если [comm_status] отображается как атрибут функции, он также не может отображаться как атрибут параметра.

function-name

Указывает имя функции, определенное в IDL-файле.

Атрибуты параметра ACF

Задает атрибуты, применяемые к параметру. Обратите внимание, что к параметру можно применить ноль, один или несколько атрибутов. Разделяйте несколько атрибутов параметров запятыми. Атрибуты параметров заключаются в квадратные скобки. Атрибуты параметров IDL, такие как атрибуты направления, не допускаются в ACF. Обратите внимание, что если [comm_status] отображается в качестве атрибута параметра, он также не может отображаться как атрибут функции.

parameter-name

Задает параметр для функции, как определено в IDL-файле. Каждый параметр для функции должен быть указан в одной последовательности, используя то же имя, что и в IDL-файле.

Комментарии

Атрибут [comm_status] можно использовать как атрибут функции или как атрибут параметра, но он может отображаться только один раз для каждой функции. Его можно применить к функции или к одному параметру в каждой функции.

Атрибут [comm_status] может применяться только к функциям, возвращающим тип error_status_t. При возникновении ошибки связи во время выполнения функции возвращается код ошибки.

Если в качестве атрибута параметра используется [comm_status] , параметр должен быть определен в IDL-файле и должен быть параметром [out] типа error_status_t. При возникновении ошибки связи во время выполнения функции параметру присваивается код ошибки. После успешного завершения удаленного вызова процедура задает значение .

Атрибуты [comm_status] и [fault_status] могут отображаться в одной функции в виде атрибутов функции или атрибутов параметров. Если оба атрибута являются атрибутами функции или если они применяются к одному и тому же параметру без ошибок, функция или параметр имеет значение error_status_ok. В противном случае он содержит соответствующее значение [comm_status] или [fault_status] . Поскольку значения, возвращаемые для [comm_status] , отличаются от значений, возвращаемых для [fault_status], возвращаемые значения легко интерпретируются.

См. также раздел

Файл конфигурации приложения (ACF)

error_status_t

fault_status

nocode

out