Main Application Options

The Main Application is a .NET 2.0 Windows Forms application which does not display a window. Its purpose is to accept various command line parameters, and to execute either the Windows, or the Console application, depending on the specific command line parameters. Once this is done the application quits. It provides the function of a single entry-point launcher application for the selective execution of either the Windows or Console application. See the following section for more information.

Application Execution

The application can be executed with the following command line:

• spy.doc[.exe] [/c][/h] [["]spydocProject["]]

The '[]' parentheses are used to indicate optional parameters. The spydocProject parameter should be enclosed in quotation symbols, if the file path contains spaces or other symbols that may affect the way the path is interpreted as a command line parameter. If no parameters are provided, the application will start the Windows application and quit.

/c

If present, this parameter causes the application to start the Console application, passing to it the rest of the command line excluding the '/c'. If the '/h' parameter is also present, the application information message box is displayed, and the application quits. If this paramater is not present, but the spydocProject parameter is specified, the Windows application is started instead.

/h

If present, this parameter causes the application information message box to be displayed, and the application quits.

spydocProject

This parameter is the full or relative path of the spy.doc project file to load and execute. The application will start the Windows or Console application dependent on the '/c' parameter documented above. In the case of the Windows application, the main window of that application is displayed with the project loaded. In the case of the Console application, it will load and execute the project, quitting once the documentation generation is completed, or an error is encountered.

Application Information

The application displays the information message box, if it cannot determine which of the Windows or Console application to execute, or if the '/h' parameter is also present. When the message box is dismissed by the user, the application quits. The displayed information text is shown below:

• spy.doc Version 2007.1
  Copyright(c) Businessware Architects 2007
  Command: spy.doc [/c][/h] [["]spydocProject["]]
      c:  Use console mode of operation.
      h:  Show help text.
      spydocProject: spy.doc project path (including file extension) to load and execute.