QMConnectLocal()

Top  Previous  Next

 

The QMConnectLocal() function establishes a QMClient session on the local system.

 

 

Format

 

VBQMConnectLocal(ByVal Account as String) as Boolean

 

Cint QMConnectLocal(char * Account)

 

where

 

Accountis the name of the QM account to be accessed.

 

 

The QMConnectLocal() function attempts to establish a QMClient process on the local system. The process runs as the user executing the function. If successful, the function returns True. If unsuccessful, the function returns False and the QMError() function can be used to retrieve a text error message identifying the cause of the failure.

 

A single client may open up to four connections simultaneously. The internal session number associated with the session opened by QMConnectLocal() can be retrieved using QMGetSession(). All subsequent QMClient function calls relate to the most recently opened session unless QMSetSession() is used to select an alternative session.

 

QMClient sessions run the LOGIN paragraph (if present) but not the MASTER.LOGIN paragraph. A QMClient session can be recognised within this paragraph by testing the value of @TTY which will be "vbsrvr" for QMClient.

 

NOTE: The underlying operating system call needed by QMConnectLocal() is not implemented on Windows 98/ME. It will be necessary to use QMConnect for these systems.

 

QMConnectLocal() is not supported by the QMBasic class module API.