Function tidyGetMessageArguments

Source
pub unsafe extern "C" fn tidyGetMessageArguments(
    tmessage: TidyMessage,
) -> TidyIterator
Expand description

Initiates an iterator for a list of arguments related to a given message. This iterator allows you to iterate through all of the arguments, if any. In order to iterate through the arguments, initiate the iterator with this function, and then use tidyGetNextMessageArgument() to retrieve the first and subsequent arguments. For example: @code{.c} TidyIterator itArg = tidyGetMessageArguments( tmessage ); while ( itArg ) { TidyMessageArgument my_arg = tidyGetNextMessageArgument( tmessage, &itArg ); // do something with my_arg, such as inspect its value or format } @endcode @param tmessage The message about whose arguments you wish to query. @result Returns a TidyIterator, which is a token used to represent the current position in a list within LibTidy.