Report Arguments Interrogation API

Detailed Description

Functions
TY_PRIVATE ctmbstr	TY_❪getArgFormat❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the format specifier of the given message argument. More...
TY_PRIVATE TidyFormatParameterType	TY_❪getArgType❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the TidyFormatParameterType of the given message argument. More...
TY_PRIVATE double	TY_❪getArgValueDouble❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the double value of the given message argument. More...
TY_PRIVATE int	TY_❪getArgValueInt❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the integer value of the given message argument. More...
TY_PRIVATE ctmbstr	TY_❪getArgValueString❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the string value of the given message argument. More...
TY_PRIVATE uint	TY_❪getArgValueUInt❫ (TidyMessageImpl message, TidyMessageArgument *arg)
	Returns the unsigned integer value of the given message argument. More...
TY_PRIVATE TidyIterator	TY_❪getMessageArguments❫ (TidyMessageImpl message)
	Initializes the TidyIterator to point to the first item in the message's argument. More...
TY_PRIVATE 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

TY_❪getArgFormat❫()

TY_PRIVATE 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.

TY_❪getArgType❫()

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

Returns the TidyFormatParameterType of the given message argument.

TY_❪getArgValueDouble❫()

TY_PRIVATE 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.

TY_❪getArgValueInt❫()

TY_PRIVATE 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.

TY_❪getArgValueString❫()

TY_PRIVATE 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.

TY_❪getArgValueUInt❫()

TY_PRIVATE 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.

TY_❪getMessageArguments❫()

TY_PRIVATE 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.

TY_❪getNextMessageArgument❫()

TY_PRIVATE 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.