[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
+------------------------------------------------------------------------+
| Option Description |
-------------------------------------------------------------------------|
| /a Report average times. |
| /c Directs output to console (standard output). |
| /d Directs output to .DBF file. |
| /lm:margin Set report left margin. (The default=0.) |
| /m Include module names. |
| /n:width Set width of NAME column. (The default=16.) |
| /o Overlay statistics only. |
| /p Report percentages of runtime. |
| /pl:length Set report page length. (The default=66) |
| /sa Sort by average times. |
| /sc Sort by numbers of calls. |
| /su Sort by cumulative times. |
| /t Collect timing statistics only. |
| /u Report cumulative times. |
| /z Include never-called functions. |
+------------------------------------------------------------------------+
WSPSTAT [options] WSPFILE[.WSP] [OUTPUT [.WSS]]
All options must precede the file name. The square brackets ([ ]) indicate
an item is optional. Do not use the brackets. Italics indicate an item is
replaced with a user-defined value or option. Options refer to the WSPSTAT
options described below. WSPFILE is the name of the .WSP file created by
WSPRUN. output is the name of the file created by WSPSTAT. The default
extension is .WSS, however WarpSpeed can create a .DBF file instead.
WSPSTAT Options Details
/a Report average times.
Description
This option reports average time (seconds) per function call. The
average time is the total function time divided by the number of calls to
that function.
/c Directs output to console (standard output).
Description
This option directs WSPSTAT output to the console (standard output).
/c sends a report to standard output instead of a file. When this option
used, a .WSS (or .DBF) file is not created. Instead, the results are
routed to the standard output device.
/d Directs output to .DBF file.
Description
This option directs output to a .DBF file. /d generates a Clipper or
dBASE compatible file instead of .WSS file. Each record contains the
following fields:
+------------------------------------------------+
| Field Type Size/Format |
-------------------------------------------------|
| NAME Character 16 |
| MODULE Character 12 |
| RECTYPE Character 1 |
| NCALLS Numeric 8.0 |
| FCNTIME Numeric 10.3 |
| CUMTIME Numeric 10.3 |
+------------------------------------------------+
The size of the NAME field is set by using the /n option. RECTYPE is
blank for normal records except for the first five records in the .DBF
file. The values for NAME and RECTYPE for the first five records
are:
+------------------------------------------------+
| Name RECTYPE |
-------------------------------------------------|
| Elapsed time E |
| Runtime R |
| Profiler time P |
| DOS/BIOS time D |
| Overlay Manager O |
+------------------------------------------------+
For the first five records, FCNTIME and CUMTIME both contain the
appropriate time value. For the Overlay Manager record, NCALLS
contains the number of overlaid function calls.
/lm:margin Set report left margin. (The default=0.)
Syntax
Margin is the size of the left margin in characters. The default is zero.
Description
This option sets the left margin of the report. Top and bottom margins
are fixed at one line each. The right margin is not adjustable. It is
assumed that the destination printer is wide enough to contain all of the
data.
/m Include module names.
Description
This option includes module names. The module names are used for
Clipper version 5 if STATIC functions were profiled, using the /n option
of WSPRUN.
/n:width Set width of NAME column. (The default=16.)
Syntax
Width is a number. The default width is 16.
Description
This option sets the width of the NAME column in the .DBF file created
by WSPSTAT. You must use /n with the /d option.
/o Overlay statistics only.
Description
This option includes overlay statistics for WSPSTAT. It does not include
the timing table.
/p Report percentages of runtime.
Description
This option reports a percentage of the runtime (seconds) for each function.
/pl:length Set report page length.
Syntax
Length is a number. The default is 66 lines.
Description
This option sets the report page length for the output file.
/sa Sort by average times.
/sc Sort by numbers of calls.
/su Sort by cumulative times.
Description
These options sort the output in descending order by: average time
(/sa), number of calls (/sc), or cumulative time (/su). The default is to
sort by function time.
/t Collect timing statistics only.
Description
This option includes the timing statistics for WSPSTAT. It does not
include the load/reload table.
/u Report cumulative times.
Description
This option reports cumulative times for each function.
/z Include never-called functions.
Description
The report includes functions that were never called.
Additional Technical Information
Your program will run slower under the profiler. The speed loss depends
upon which functions you choose to profile and can range from imperceptibly
small up to a factor of 20 or more. The profiler also requires some memory:
about 4K plus the size of your environment plus 18 bytes for each activation
record, plus 15 bytes for each function profiled.
File names and module names are taken from the Detailed Segment Map within
the map file. Any drive or path specifications are stripped off both. All
string matches are not case-sensitive.
Do not profile a hardware interrupt handler or any function called by a
hardware interrupt handler (including the timer tick). Be very careful about
including libraries unless you know the implications of changing the
internal program.
You should not profile self-modifying code. Some floating point emulation
libraries (such as EMU.LIB from Borland C/C++) use self-modifying code and
errors will occur if you try to profile these libraries.
Online resources provided by: http://www.ClipX.Net --- NG 2 HTML conversion by Dave Pearson