Functions
StatusInt	mdlDialog_closeCommandQueue (MSDialogP dbP)
	Queues a DMSG_CANCEL command to close the specified Dialog Box. More...

void	mdlDialog_cmdNumberQueue (bool localCmd, CommandNumber cmdNum, WCharCP unparsedP, MSInputQueuePos queuePosition)
	Queues the command specified by cmdNum onto the input queue. More...

void	mdlDialog_cmdNumberSyncQueue (bool localCmd, CommandNumber cmdNum, WCharCP unparsedP, MSInputQueuePos queuePosition)
	Queues the command specified by cmdNum onto the input queue. More...

void	mdlDialog_cmdNumQueueExt (bool localCmd, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos queuePosition, bool bJournal)
	Queues the command specified by cmdNum onto the input queue and optionally journals the command if CAD input journaling is active. More...

void	mdlDialog_cmdNumSyncQueueExt (bool localCmd, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos queuePosition, bool bJournal)
	Queues the command specified by cmdNum onto the input queue and optionally journals the command if CAD input journaling is active. More...

void	mdlDialog_cmdNumberQueueByDb (MSDialogP dbP, bool localCmd, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos position)
	Sends a command number input queue element to the owner of a particular Dialog Box. More...

void	mdlDialog_cmdNumberSyncQueueByDb (MSDialogP dbP, bool localCmd, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos position)
	Sends a command number input queue element to the owner of a particular Dialog Box. More...

void	mdlDialog_cmdNumQByDbExt (MSDialogP dbP, bool localCmd, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos position, bool bJournal)
	Sends a command number input queue element to the owner of a particular Dialog Box. More...

void	mdlDialog_cmdNumSyncQByDbExt (MSDialogP dbP, bool localCmd, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos position, bool bJournal)
	Sends a command number input queue element to the owner of a particular Dialog Box. More...

void	mdlDialog_cmdNumberQueueByTaskId (WCharCP taskIdP, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos position)
	Sends a command number input queue element to a task. More...

void	mdlDialog_cmdNumberSyncQueueByTaskId (WCharCP taskIdP, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos position)
	Sends a command number input queue element to a task. More...

void	mdlDialog_cmdNumSyncQByTaskIdExt (WCharCP taskIdP, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos position, bool bJournal)
	Sends a command number input queue element to a task. More...

void	mdlDialog_cmdNumQByTaskIdExt (WCharCP taskIdP, CommandNumber cmdNum, WCharCP unparsed, MSInputQueuePos position, bool bJournal)
	Sends a command number input queue element to a task. More...

StatusInt	mdlDialog_getCurrentCmdKeyin (WStringR fullKeyin)
	Gets the current Keyin, either from the global command number or from the current named tool. More...

Detailed Description

Function Documentation

StatusInt mdlDialog_closeCommandQueue ( MSDialogP dbP )

Queues a DMSG_CANCEL command to close the specified Dialog Box.

Parameters

[in] dbP dialog to queue close command for

Returns: SUCCESS, or true if an error occurs. This means that dbP is not a pointer to a Dialog Box.

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumberQueue	(	bool	localCmd,
		CommandNumber	cmdNum,
		WCharCP	unparsedP,
		MSInputQueuePos	queuePosition
	)

Queues the command specified by cmdNum onto the input queue.

Parameters

[in]	localCmd	parameter should be set to true if the command is from the calling application's command table. Otherwise the command will be assumed to be from MicroStation's command table.
[in]	cmdNum	command number to queue
[in]	unparsedP	parameter points at a NULL terminated Unicode string which will be placed on the input queue along with cmdNum. Specifying unparsed simulates the user keying-in the command indicated by cmdNum, a space character, and then the unparsed string.
[in]	queuePosition	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning. beginning of the input queue.

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumberQueueByDb	(	MSDialogP	dbP,
		bool	localCmd,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	position
	)

Sends a command number input queue element to the owner of a particular Dialog Box.

The command is also journaled if CAD input journaling is active.

Parameters

[in]	dbP	is the Dialog Box from which the target MDL task is determined.
[in]	localCmd	if true, indicates that the command number being queued is local to the application and not a MicroStation command.
[in]	cmdNum	is the command number to queue to the target task.
[in]	unparsed	is any unparsed (string) portion of the command that the calling application wants parsed by the target task.
[in]	position	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning.

See also: mdlDialog_cmdNumberQueueByTaskId mdlDialog_cmdNumQByTaskIdExt mdlDialog_cmdNumQByDbExt

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumberQueueByTaskId	(	WCharCP	taskIdP,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	position
	)

Sends a command number input queue element to a task.

The command is also journaled if CAD input journaling is active.

Parameters

[in]	taskIdP	is the name of the target task, also known as the task ID, to receive the input command queue element.
[in]	cmdNum	is the command number to queue to the target task.
[in]	unparsed	is any unparsed (string) portion of the command that the calling application wants parsed by the target task.
[in]	position	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning.

See also: mdlDialog_cmdNumberQueueByDb mdlDialog_cmdNumQByDbExt mdlDialog_cmdNumQByTaskIdExt

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumberSyncQueue	(	bool	localCmd,
		CommandNumber	cmdNum,
		WCharCP	unparsedP,
		MSInputQueuePos	queuePosition
	)

Queues the command specified by cmdNum onto the input queue.

This function behaves synchronously - it returns when the task is complete.

Parameters

[in]	localCmd	parameter should be set to true if the command is from the calling application's command table. Otherwise the command will be assumed to be from MicroStation's command table.
[in]	cmdNum	command number to queue
[in]	unparsedP	parameter points at a NULL terminated string which will be placed on the input queue along with cmdNum. Specifying unparsed simulates the user keying-in the command indicated by cmdNum, a space character, and then the unparsed string.
[in]	queuePosition	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning. beginning of the input queue.

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumberSyncQueueByDb	(	MSDialogP	dbP,
		bool	localCmd,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	position
	)

Sends a command number input queue element to the owner of a particular Dialog Box.

The command is also journaled if CAD input journaling is active. This function behaves synchronously - it returns when the task is complete.

Parameters

[in]	dbP	is the Dialog Box from which the target MDL task is determined.
[in]	localCmd	if true, indicates that the command number being queued is local to the application and not a MicroStation command.
[in]	cmdNum	is the command number to queue to the target task.
[in]	unparsed	is any unparsed (string) portion of the command that the calling application wants parsed by the target task.
[in]	position	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning.

See also: mdlDialog_cmdNumberSyncQueueByTaskId mdlDialog_cmdNumSyncQByTaskIdExt mdlDialog_cmdNumSyncQByDbExt

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumberSyncQueueByTaskId	(	WCharCP	taskIdP,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	position
	)

Sends a command number input queue element to a task.

The command is also journaled if CAD input journaling is active. This function behaves synchronously - it returns when the task is complete.

Parameters

[in]	taskIdP	is the name of the target task, also known as the task ID, to receive the input command queue element.
[in]	cmdNum	is the command number to queue to the target task.
[in]	unparsed	is any unparsed (string) portion of the command that the calling application wants parsed by the target task.
[in]	position	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning.

See also: mdlDialog_cmdNumberSyncQueueByDb mdlDialog_cmdNumSyncQByDbExt mdlDialog_cmdNumSyncQByTaskIdExt

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumQByDbExt	(	MSDialogP	dbP,
		bool	localCmd,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	position,
		bool	bJournal
	)

Sends a command number input queue element to the owner of a particular Dialog Box.

However, if CAD input journaling is active, the command is journaled only if bJournal is true.

Parameters

[in]	dbP	is the Dialog Box from which the target MDL task is determined.
[in]	localCmd	if true, indicates that the command number being queued is local to the application and not a MicroStation command.
[in]	cmdNum	is the command number to queue to the target task.
[in]	unparsed	is any unparsed (string) portion of the command that the calling application wants parsed by the target task.
[in]	position	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning.
[in]	bJournal	should be set to false if the command should not be journaled when CAD input journaling is active.

See also: mdlDialog_cmdNumberQueueByTaskId mdlDialog_cmdNumQByTaskIdExt mdlDialog_cmdNumberQueueByDb

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumQByTaskIdExt	(	WCharCP	taskIdP,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	position,
		bool	bJournal
	)

Sends a command number input queue element to a task.

However, if CAD input journaling is active, the command is journaled only if bJournal is true.

Parameters

[in]	taskIdP	is the name of the target task, also known as the task ID, to receive the input command queue element.
[in]	cmdNum	is the command number to queue to the target task.
[in]	unparsed	is any unparsed (string) portion of the command that the calling application wants parsed by the target task.
[in]	position	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning.
[in]	bJournal	should be set to false if the command should not be journaled when CAD input journaling is active.

See also: mdlDialog_cmdNumberQueueByDb mdlDialog_cmdNumQByDbExt mdlDialog_cmdNumberQueueByTaskId

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumQueueExt	(	bool	localCmd,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	queuePosition,
		bool	bJournal
	)

Queues the command specified by cmdNum onto the input queue and optionally journals the command if CAD input journaling is active.

Parameters

[in]	localCmd	should be set to true if the command is from the calling application's command table. Otherwise, the command will be assumed to be from MicroStation's command table.
[in]	cmdNum	command number to queue
[in]	unparsed	points to a null terminated string which will be placed on the input queue along with cmdNum. Specifying unparsedP simulates the user keying-in the command indicated by cmdNum, a space character, and then the unparsedP string.
[in]	queuePosition	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning. the input queue.
[in]	bJournal	should be set to false if the command should not be journaled when CAD input journaling is active.

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumSyncQByDbExt	(	MSDialogP	dbP,
		bool	localCmd,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	position,
		bool	bJournal
	)

Sends a command number input queue element to the owner of a particular Dialog Box.

However, if CAD input journaling is active, the command is journaled only if bJournal is true. This function behaves synchronously - it returns when the task is complete.

Parameters

[in]	dbP	is the Dialog Box from which the target MDL task is determined.
[in]	localCmd	if true, indicates that the command number being queued is local to the application and not a MicroStation command.
[in]	cmdNum	is the command number to queue to the target task.
[in]	unparsed	is any unparsed (string) portion of the command that the calling application wants parsed by the target task.
[in]	position	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning.
[in]	bJournal	should be set to false if the command should not be journaled when CAD input journaling is active.

See also: mdlDialog_cmdNumberSyncQueueByTaskId mdlDialog_cmdNumSyncQByTaskIdExt mdlDialog_cmdNumberSyncQueueByDb

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumSyncQByTaskIdExt	(	WCharCP	taskIdP,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	position,
		bool	bJournal
	)

Sends a command number input queue element to a task.

However, if CAD input journaling is active, the command is journaled only if bJournal is true. This function behaves synchronously - it returns when the task is complete.

Parameters

[in]	taskIdP	is the name of the target task, also known as the task ID, to receive the input command queue element.
[in]	cmdNum	is the command number to queue to the target task.
[in]	unparsed	is any unparsed (string) portion of the command that the calling application wants parsed by the target task.
[in]	position	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning.
[in]	bJournal	should be set to false if the command should not be journaled when CAD input journaling is active.

See also: mdlDialog_cmdNumberSyncQueueByDb mdlDialog_cmdNumSyncQByDbExt mdlDialog_cmdNumberSyncQueueByTaskId

Remarks: Required Library: mdlbltin.lib

void mdlDialog_cmdNumSyncQueueExt	(	bool	localCmd,
		CommandNumber	cmdNum,
		WCharCP	unparsed,
		MSInputQueuePos	queuePosition,
		bool	bJournal
	)

Queues the command specified by cmdNum onto the input queue and optionally journals the command if CAD input journaling is active.

This function behaves synchronously - it returns when the task is complete.

Parameters

[in]	localCmd	should be set to true if the command is from the calling application's command table. Otherwise, the command will be assumed to be from MicroStation's command table.
[in]	cmdNum	command number to queue
[in]	unparsed	points to a null terminated string which will be placed on the input queue along with cmdNum. Specifying unparsedP simulates the user keying-in the command indicated by cmdNum, a space character, and then the unparsedP string.
[in]	queuePosition	Use PUTQ_EOF for end of queue, PUTQ_HEAD for beginning. the input queue.
[in]	bJournal	should be set to false if the command should not be journaled when CAD input journaling is active.

Remarks: Required Library: mdlbltin.lib

StatusInt mdlDialog_getCurrentCmdKeyin ( WStringR fullKeyin )

Gets the current Keyin, either from the global command number or from the current named tool.

Parameters

[out] fullKeyin receives the current keyin

Returns: SUCCESS, or true if an error occurs.

Remarks: Required Library: mdlbltin.lib

Functions

Detailed Description

Function Documentation