msys.h File Reference

<mi32/msys.h> System functions More...

#include <mi32/stddefns.h>

Include dependency graph for msys.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	CHILDPROCESS_DiedCoreDump   3
#define	CHILDPROCESS_DiedNoCoreDump   4
#define	CHILDPROCESS_ExitError   1
#define	CHILDPROCESS_ExternalStop   2
#define	CHILDPROCESS_Finished   0
Functions
void	MsysAppCleanup ()
const char *	MsysAppGetName ()
void	MsysAppGetProductInfo (MISTRING &string)
void	MsysAppInitialize (const char *procname, UINT32 ProductCode=0)
void	MsysAppOnExitFuncAdd (void(*pfunc)(void *), void *pdata=0)
void	MsysAppOnExitFuncRemove (void(*pfunc)(void *), void *pdata=0)
void	MsysAppSetName (const char *newname)
bool	MsysGetLocalIP (UINT8 ip[6])
int	MsysOpenReferenceDocument (const char *doctag)
ERRVALUE	MsysRunAssocApp (const UNICODE *docname)
int	MsysRunProcess (const UNICODE *progstr, void(*EndCB)(int pid, int result, void *udata)=0, void *udata=0)

---

Detailed Description

<mi32/msys.h> System functions

Definition in file msys.h.

---

Define Documentation

#define CHILDPROCESS_DiedCoreDump   3

Definition at line 170 of file msys.h.

#define CHILDPROCESS_DiedNoCoreDump   4

Definition at line 171 of file msys.h.

#define CHILDPROCESS_ExitError   1

Definition at line 168 of file msys.h.

#define CHILDPROCESS_ExternalStop   2

Definition at line 169 of file msys.h.

#define CHILDPROCESS_Finished   0

Possible "result" values passed to the EndCB of MsysRunProcess These used to be in mbfdefns.h, but that include file is no more. Apparently Windows only uses CHILDPROCESS_Finished. The Unix platforms can get the other values Definition at line 167 of file msys.h.

---

Function Documentation

void MsysAppCleanup (   )

Perform application cleanup prior to exit. Calls registered OnExit functions, disconnects from RVC, etc.

const char* MsysAppGetName (   )

Get application name. Returns: Pointer to application name. Do NOT free the pointer returned.

void MsysAppGetProductInfo (  MISTRING &  string  )

Get descriptive information about product for use in 'Help About' dialogs. Parameters: string  String returned.

void MsysAppInitialize (  const char *  procname, UINT32  ProductCode = 0 )

Initialize application. Parameters: procname  Process name for default INI and msgfile group, NULL to not set ProductCode  ID of product, 0 for TNTmips

void MsysAppOnExitFuncAdd (  void(*  pfunc)(void *), void *  pdata = 0 )

Add function to be called on application exit during MsysAppCleanup(). Functions are called starting with the most recently added. Parameters: pdata  Pointer to function to call Optional data to passe to function

void MsysAppOnExitFuncRemove (  void(*  pfunc)(void *), void *  pdata = 0 )

Remove previously added OnExit function. Parameters: pdata  Pointer to function to remove Optional data, must match value used in MsysAppOnExitFuncAdd

void MsysAppSetName (  const char *  newname  )

Set application "name" for later retrieval by MsysAppGetName(). Parameters: newname  New application name to set

bool MsysGetLocalIP (  UINT8  ip[6]  )

Get IP address of local machine. Returns 'true' if X server and client are on same machine (or if not X platform). Parameters: ip  IP address returned if available

int MsysOpenReferenceDocument (  const char *  doctag  )

Open 'reference' document using specified tag. Returns: Error < 0, FALSE if unrecognized tag, TRUE if valid tag. Tag must be in one of the forms: 'TNT:refman/file.pdf#NamedDestination' 'TNT:getstart/file.pdf?page=XXX' 'GETSTART:file.pdf' 'FILE:filename'

ERRVALUE MsysRunAssocApp (  const UNICODE *  docname  )

Run application "associated" with given file and pass file as parameter to it. On systems where there is no operating system-defined association system, the associations are specified by extension in the "AppAssoc" section of tnthost.ini. Parameters: docname  Name of document file

int MsysRunProcess (  const UNICODE *  progstr, void(*  EndCB)(int pid, int result, void *udata) = 0, void *  udata = 0 )

INC_MI32_MSYS_H.

---