Report Arguments Interrogation API

Detailed Description

Functions
ctmbstr	TY_❪getArgFormat❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the format specifier of the given message argument. More...
TidyFormatParameterType	TY_❪getArgType❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the TidyFormatParameterType of the given message argument. More...
double	TY_❪getArgValueDouble❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the double value of the given message argument. More...
int	TY_❪getArgValueInt❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the integer value of the given message argument. More...
ctmbstr	TY_❪getArgValueString❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the string value of the given message argument. More...
uint	TY_❪getArgValueUInt❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the unsigned integer value of the given message argument. More...
TidyIterator	TY_❪getMessageArguments❫ (TidyMessageImpl message)
	Initializes the TidyIterator to point to the first item in the message's argument. More...
TidyMessageArgument	TY_❪getNextMessageArgument❫ (TidyMessageImpl message, TidyIterator *iter)
	Returns the next TidyMessageArgument, for the given message, which can then be interrogated with the API, and advances the iterator. More...

Function Documentation

ctmbstr TY_❪getArgFormat❫	(	TidyMessageImpl	message,
		TidyMessageArgument *	arg
	)

Returns the format specifier of the given message argument.

The memory for this string is cleared upon termination of the callback, so do be sure to make your own copy.

TidyFormatParameterType TY_❪getArgType❫	(	TidyMessageImpl	message,
		TidyMessageArgument *	arg
	)

Returns the TidyFormatParameterType of the given message argument.

double TY_❪getArgValueDouble❫	(	TidyMessageImpl	message,
		TidyMessageArgument *	arg
	)

Returns the double value of the given message argument.

An assertion will be generated if the argument type is not a double.

int TY_❪getArgValueInt❫	(	TidyMessageImpl	message,
		TidyMessageArgument *	arg
	)

Returns the integer value of the given message argument.

An assertion will be generated if the argument type is not an integer.

ctmbstr TY_❪getArgValueString❫	(	TidyMessageImpl	message,
		TidyMessageArgument *	arg
	)

Returns the string value of the given message argument.

An assertion will be generated if the argument type is not a string.

uint TY_❪getArgValueUInt❫	(	TidyMessageImpl	message,
		TidyMessageArgument *	arg
	)

Returns the unsigned integer value of the given message argument.

An assertion will be generated if the argument type is not an unsigned integer.

TidyIterator TY_❪getMessageArguments❫

(

TidyMessageImpl

message

)

Initializes the TidyIterator to point to the first item in the message's argument.

Use TY_(getNextMEssageArgument) to get an opaque instance of TidyMessageArgument for which the subsequent interrogators will be of use.

TidyMessageArgument TY_❪getNextMessageArgument❫	(	TidyMessageImpl	message,
		TidyIterator *	iter
	)

Returns the next TidyMessageArgument, for the given message, which can then be interrogated with the API, and advances the iterator.