Programmer Guide/Macro Library/Kernal/StdLib: Difference between revisions
From STX Wiki
< Programmer Guide | Macro Library | Kernal
Jump to navigationJump to search
| Line 78: | Line 78: | ||
==AppCleanup== | ==AppCleanup== | ||
This macro is called by <code>APPMAIN<code> to cleanup shell items. It deletes all shell items created by an application. It can also be called from the application to remove all shell items (<code>APPCLEANUP ALL</code>) or spu-items only (<code>APPCLEANUP SPU</code>). | This macro is called by <code>APPMAIN</code> to cleanup shell items. It deletes all shell items created by an application. It can also be called from the application to remove all shell items (<code>APPCLEANUP ALL</code>) or spu-items only (<code>APPCLEANUP SPU</code>). | ||
Revision as of 09:49, 7 May 2012
- File: STDLIB.STX, linked to library STX.LIB
- Title: STx main library
- Content
application management → AppLoad · AppMain · AppCleanup · AppHelp — message handling → PostMessage · SetMsgHandler · DispatchMsg · MsgQueue · MsgFilter · GetMessage — utilities for standard
STx applications→ ExtSetup · PlayCursor · GenerateScaleParams · MetaSegment — file functions → stxFileTypeList · stxFileType · SectionFile · FileToolBox — display functions → LogWindow · ConLog · UM and EM · ShowItem — dialog and window functions → CreateMenu · DoModalDialog · SetModalWindow · GetWindowPos · SetWindowPos · WindowSizeDlg · GetMonitor · GetDesktop · ProgressBox · InitDialogItem · SetControlMode — SPU and graph functions → SetGraphXScale · GetOutputValue — SPUs → XScaleLinear · XScaleBark · Table2Output · Wave2output
- Variables and items used by this library
name type description
AppLoad
APPLOAD appname [ ; appargs ]
- Load and run a registered STx application.
| argument | description | default |
|---|---|---|
| appname | Name of a registered STx application. | |
| appargs | Arguments for the application. | |
| RESULT | description | |
| void | This macro has no return value. |
- Examples
- Start the realtime analyser:
appload rtanalyse - Start a script:
appload bscript run ; $@root\scripts\myscript.sts ; mymacro ; arg1 arg2
AppMain
This is the STx application main macro. It is called by the application management system to initialize, run and finish STx applications. This macro can not be called from other macros.
To end an application and return directly to APPMAIN the command EXIT -1 can be used.
- Note
- At the end of an application, the sourcecode is unloaded. To avoid unloading the variable
AppNoUnloadmust be set to1before returning toAPPMAIN.
AppCleanup
This macro is called by APPMAIN to cleanup shell items. It deletes all shell items created by an application. It can also be called from the application to remove all shell items (APPCLEANUP ALL) or spu-items only (APPCLEANUP SPU).
