Utility Functions and C Language Reference > Utility Functions: C Language (lr_) > Alphabetical Listing > lr_set_custom_error_message

lr_set_custom_error_message

Sets a custom text to be output after built-in error messages.

C Language

int lr_set_custom_error_message( const char *format, exp1, exp2,...expn. ); 
Example: lr_set_custom_error_message and lr_remove_custom_error_message Message Functions

Arguments

Name Comments
format C Language A formatted string to send to the Output window. You can specify a literal string in quotation marks or use the standard Message Formatting that is available for printf.
exp1, exp2,.. expn The expressions or variables to be formatted.

The lr_set_custom_error_message function sets a text to be output after the built-in error messages when an error message is issued.

The message is canceled with lr_remove_custom_error_message.

Return Values

This function returns LR_PASS (0) on success, and LR_FAIL (1) on failure.

Parameterization

All string input arguments can be passed using standard parameterization.

Concept Link IconSee Also