Documentation

Output descriptions of selected tsmApi arguments.

Through the use of functons such as tsmParseInitArgs, you can let the tsmApi parse your application's command line arguments for you and perform certain actions on these. In the future, more tsmApi arguments may be supported so we need an extensible way to describe all of the functions that an application currently supports, for example when displaying the program usage to the terminal.

This function will print out all of the arguments (with a description of their usage) that tsmApi currently supports in it's various automatic parsing routines. Output is directed to stdout.

The parameter that you pass to this function details which of tsmApi's parse functions you have used, and hence which sets of arguments your application supports, e.g. this can be any combination of the following constants:

TSM_ARG_INIT: if you used the tsmParseInitArgs function to parse any general state tsmApi arguments.

TSM_ARG_READ: if you used the tsmParseReadArgs function to parse any read connection preferences.

TSM_ARG_WRITE: if you used the tsmParseWriteArgs function to parse any write connection preferences.

TSM_ARG_VRML: if you used the tsmParseVRMLArgs function to parse any write connection preferences.

TSM_ARG_CONNECT: if you used the tsmParseConnectArgs function to parse any write connection preferences. Note that this will output options for both a read or a write connection. To try and be a bit more intelligent, the read connection settings will be output if the TSM_ARG_READ value is being passed in also (or if neither the TSM_ARG_READ or TSM_ARG_WRITE values are being passed in). And similarly for the write connection settings.