atributo comm_status
O atributo ACF [comm_status] faz com que um código de erro seja retornado quando ocorre um erro de comunicação durante a execução de uma função.
[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
, ...);
Parâmetros
-
ACF-function-attributes
-
Especifica zero ou mais atributos de função ACF, como [comm_status] e [nocode]. Os atributos de função são colocados entre colchetes. Zero ou mais atributos podem ser aplicados a uma função. Separe vários atributos de função com vírgulas. Observe que, se [comm_status] aparecer como um atributo de função, ele também não poderá aparecer como um atributo de parâmetro.
-
nome da função
-
Especifica o nome da função conforme definido no arquivo IDL.
-
ACF-parameter-attributes
-
Especifica atributos que se aplicam a um parâmetro . Observe que zero, um ou mais atributos podem ser aplicados ao parâmetro . Separe vários atributos de parâmetro com vírgulas. Os atributos de parâmetro são colocados entre colchetes. Atributos de parâmetro IDL, como atributos direcionais, não são permitidos no ACF. Observe que se [comm_status] aparecer como um atributo de parâmetro, ele também não poderá aparecer como um atributo de função.
-
parameter-name
-
Especifica o parâmetro para a função conforme definido no arquivo IDL. Cada parâmetro para a função deve ser especificado na mesma sequência, usando o mesmo nome definido no arquivo IDL.
Comentários
O atributo [comm_status] pode ser usado como um atributo de função ou como um atributo de parâmetro, mas pode aparecer apenas uma vez por função. Ele pode ser aplicado à função ou a um parâmetro em cada função.
O atributo [comm_status] só pode ser aplicado a funções que retornam o tipo error_status_t. Quando ocorre um erro de comunicação durante a execução da função, um código de erro é retornado.
Quando [comm_status] é usado como um atributo de parâmetro, o parâmetro deve ser definido no arquivo IDL e deve ser um parâmetro [out] do tipo error_status_t. Quando ocorre um erro de comunicação durante a execução da função, o parâmetro é definido como o código de erro. Quando a chamada remota é concluída com êxito, o procedimento define o valor.
É possível que os atributos [comm_status] e [fault_status] apareçam em uma única função, seja como atributos de função ou atributos de parâmetro. Se ambos os atributos forem atributos de função ou se eles se aplicarem ao mesmo parâmetro e nenhum erro ocorrer, a função ou parâmetro terá o valor error_status_ok. Caso contrário, ele contém o valor apropriado [comm_status] ou [fault_status] . Como os valores retornados para [comm_status] são diferentes dos valores retornados para [fault_status], os valores retornados são prontamente interpretados.
Confira também