Name

omni_get_message_text − The omni_get_message_text procedure searches the DEComni catalog file for the error code text. 

Syntax

extern void omni_get_message_text (
       char                  ∗string,
       unsigned long int     receive_string_length,
       unsigned long int     msg_id,
       char                  ∗arg1,
       char                  ∗arg2,
       char                  ∗arg3,
       char                  ∗arg4,
       char                  ∗arg5);

Arguments

string
  access: write only mechanism: by reference A character string that receives the error message text.

receive_string_length
  access: read only mechanism: by value The length of the character string.

msg_id
  access: read only mechanism: by value The error code that is translated.

arg1...arg5
  access: read only mechanism: by value These are optional parameters reserved for future use; they must be NULL.

Usage Notes

Omni_get_message_text opens the DEComni catalog file, searches for message number msg_id, and returns the message text in the NULL terminated string pointed to by string.  Arg1 through arg5 must be passed as NULL.