VCLockMessage


Version:

2.0

Description:

Locks the status bar message to display the given message.

Declaration:

 

C/C++

extern "C" void WINAPI VCLockMessage(short* iError, char* szMess, vbool tfLock);

Delphi

procedure VCLockMessage(var iError: Smallint; szMess: PAnsiChar; tfLock: Wordbool);

ActiveX/COM

Sub LockMessage(ByVal szMess As String, ByVal tfLock As Integer)

Parameters:

szMess - the message to display, should be set to NULL when unlocking.
tfLock
- locks or unlocks the status display.
0 - unlocks the display.
1 - locks the display.

Notes:

The status bar is used to display the current tool position and guide a user through the tool operation. An application can set and change this displayed message with VCSetPrompt. Once the applications tool is complete however the default Visual CADD™ messages will show. VCLockMessage allows an application to lock all messages from the display and provide a single instruction for a user. For example, an application may never utilize prompts but instead only requires a user to make settings in an application dialog. The application can lock the message and provide a prompt such as "Enter the settings". This prompt will not be overwritten by the Visual CADD™ messaging system. The application then calls the VCLockMessage routine again to reset the prompt and allow Visual CADD™ to show the prompts.

See Also:

VCGetCmdStr