Modules
	Displaying Messages

Functions
void	mdlOutput_command (WCharCP pMessage)
	Displays the message designated by pMessage to the command field in the command window. More...

void	mdlOutput_commandU (WCharCP pMessage)
	Displays the message designated by pMessage in the command field in the command window, regardless of the state of tcb->control.inh_msg. More...

void	mdlOutput_error (WCharCP pMessage)
	Displays the message designated by pMessage in the error field in the command window. More...

void	mdlOutput_errorU (WCharCP pMessage)
	Displays the message designated by pMessage in the error field in the command window, regardless of the state of tcb->control.inh_err. More...

void	mdlOutput_keyin (WCharCP pMessage)
	Displays the message designated by pMessage in the keyin field in the command window. More...

void	mdlOutput_keyinU (WCharCP pMessage)
	Displays the message designated by pMessage in the keyin field in the command window, regardless of the state of tcb->control.inh_msg. More...

void	mdlOutput_message (WCharCP pMessage)
	Displays the message designated by pMessage in the message field in the command window. More...

void	mdlOutput_messageU (WCharCP pMessage)
	Displays the message designated by pMessage in the message field in the command window, regardless of the state of tcb->control.inh_msg. More...

int	mdlOutput_printf (int type, WCharCP formatP,...)
	Displays a message in the command window field designated by type. More...

void	mdlOutput_prompt (WCharCP pMessage)
	Displays the message designated by pMessage in the prompt field in the command window. More...

void	mdlOutput_promptU (WCharCP pMessage)
	Displays the message designated by pMessage in the prompt field in the command window, regardless of the status of tcb->control.inh_msg. More...

int	mdlOutput_rscPrintf (int type, RscFileHandle resourceFileHandle, long resourceId, int stringNumber,...)
	Displays a message in the command window field designated by type. More...

int	mdlOutput_rscfPrintf (FILE *fp, RscFileHandle resourceFileHandle, long resourceId, int stringNumber,...)
	The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions. More...

void	mdlOutput_rscsPrintf (WStringR outStr, RscFileHandle resourceFileHandle, long resourceId, int stringNumber,...)
	The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions. More...

int	mdlOutput_rscvPrintf (int type, RscFileHandle resourceFileHandle, long resourceId, int stringNumber, va_list varg)
	The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions. More...

int	mdlOutput_rscvfPrintf (FILE *fp, RscFileHandle resourceFileHandle, long resourceId, int stringNumber, va_list varg)
	The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions. More...

void	mdlOutput_rscvsPrintf (WStringR buffer, RscFileHandle resourceFileHandle, long resourceId, int stringNumber, va_list varg)
	The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions. More...

void	mdlOutput_status (WCharCP pMessage)
	Displays the message designated by pMessage in the status field in the command window. More...

void	mdlOutput_statusU (WCharCP pMessage)
	Displays the message designated by pMessage of the status field in the command window, regardless of the state if tcb->control.inh_msg. More...

int	mdlOutput_vprintf (int type, WCharCP formatP, va_list ap)
	Displays a message in the command window field designated by type. More...

void	mdlOutput_flyoverMsgU (WCharCP pMessage)
	Displays a message in the fly over field of the Status Bar, regardless of the stat of tcb->control.inh_msg. More...

void	mdlOutput_flyoverMsg (WCharCP pMessage)
	Displays a message in the fly over field of the Status Bar. More...

void	mdlOutput_setAddToMessageCenter (bool bMsgCenter)
	Toggles on or off the Message Center logging. More...

int	mdlOutput_rscvMessageCenter (DgnPlatform::OutputMessagePriority messagePriority, RscFileHandle resourceFileHandle, long resourceId, int briefStringNumber, int detailedStringNumber, DgnPlatform::OutputMessageAlert openAlertBox, va_list varg)
	Loads the specified brief message and detailed message from the resource file and sends them to the Message Center. More...

int	mdlOutput_rscMessageCenter (DgnPlatform::OutputMessagePriority messagePriority, RscFileHandle resourceFileHandle, long resourceId, int briefStringNumber, int detailedStringNumber, DgnPlatform::OutputMessageAlert openAlertBox,...)
	Loads the specified brief message and detailed message from the resource file and sends them to the Message Center. More...

int	mdlOutput_tempMessage (DgnPlatform::OutputMessagePriority messageField, WCharCP pBriefMessage, WCharCP pDetailedMessage)
	Sends the specified brief message and detailed message to the Message Center, but the messages are only temporary. More...

int	mdlOutput_messageCenterEx (DgnPlatform::OutputMessagePriority messagePriority, WCharCP pBriefMessage, WCharCP pDetailedMessage, long detailMessageAttributes, DgnPlatform::OutputMessageAlert openAlertBox)
	Sends the specified brief message and detailed message to the Message Center and specifies multi-line text item attributes for the Detailed Message area in the Message Center. More...

int	mdlOutput_messageCenter (DgnPlatform::OutputMessagePriority messagePriority, WCharCP pBriefMessage, WCharCP pDetailedMessage, DgnPlatform::OutputMessageAlert openAlertBox)
	Sends the specified message and detailed message to the Message Center. More...

Detailed Description

Function Documentation

void mdlOutput_command ( WCharCP pMessage )

Displays the message designated by pMessage to the command field in

the command window.

Remarks: A non-zero value for tcb->control.inh_err prevents mdlOutput_error from displaying messages.; A non-zero value for tcb->control.inh_msg prevents all other functions from displaying messages.

Parameters

[in] pMessage message to display

See also: mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU mdlOutput_error mdlOutput_prompt mdlOutput_keyin mdlOutput_message mdlOutput_status

Remarks: Required Library: mdlbltin.lib

void mdlOutput_commandU ( WCharCP pMessage )

Displays the message designated by pMessage in the command field in the command window, regardless of the state of tcb->control.inh_msg.

Parameters

[in] pMessage message to display

Remarks

In the status area, the command window fields correspond to status area fields as follows:


Command Window Field	Corresponding Status Area Field
command field	in the left portion of status area.
prompt field	in left portion of status area, to the right of the command string, (i.e., command> prompt).
error field	overlays the command> prompt in the left portion of the status area.
msg field	in the right portion of the status area.
status field	in the right portion of the status area, to the right of the snap mode indicator.

The flyover msg field DOES NOT EXIST in the command window. In the key-in area, it overlays the command prompt error field. This is the field where tool descriptions are displayed. It is erased automatically if a tool description is displayed, a prompt or error is displayed, or the user clicks in the status bar.

For all of these functions, the appropriate message displays regardless of the values in tcb->control.inh_err and tcb->control.inh_msg.

See also: mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status mdlOutput_errorU mdlOutput_promptU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU

Remarks: Required Library: mdlbltin.lib

void mdlOutput_error ( WCharCP pMessage )

Displays the message designated by pMessage in the error field in the command window.

Parameters

[in] pMessage error message to display

Remarks: A non-zero value for tcb->control.inh_err prevents mdlOutput_error from displaying messages.; A non-zero value for tcb->control.inh_msg prevents all other functions from displaying messages.

See also: mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status

Remarks: Required Library: mdlbltin.lib

void mdlOutput_errorU ( WCharCP pMessage )

Displays the message designated by pMessage in the error field in the command window, regardless of the state of tcb->control.inh_err.

Parameters

[in] pMessage error message to display

Remarks: See mdlOutput_commandU for a description of where messages are displayed with appropriate functions.; The flyover msg field DOES NOT EXIST in the command window. In the key-in area, it overlays the command prompt error field. This is the field where tool descriptions are displayed. It is erased automatically if a tool description is displayed, a prompt or error is displayed, or the user clicks in the status bar.

See also: mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status mdlOutput_promptU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU

Remarks: Required Library: mdlbltin.lib

void mdlOutput_flyoverMsg ( WCharCP pMessage )

Displays a message in the fly over field of the Status Bar.

Remarks: The flyover msg field DOES NOT EXIST in the command window. In the key-in area, it overlays the command prompt error field. This is the field where tool descriptions are displayed. It is erased automatically if a tool description is displayed, a prompt or error is displayed, or the user clicks in the status bar.; A non-zero value for tcb->control.inh_msg prevents this function from displaying messages.

Parameters

[in] pMessage fly over message

See also: mdlOutput_printf

Remarks: Required Library: mdlbltin.lib

void mdlOutput_flyoverMsgU ( WCharCP pMessage )

Displays a message in the fly over field of the Status Bar, regardless of the stat of tcb->control.inh_msg.

Remarks: The flyover msg field DOES NOT EXIST in the command window. In the key-in area, it overlays the command prompt error field. This is the field where tool descriptions are displayed. It is erased automatically if a tool description is displayed, a prompt or error is displayed, or the user clicks in the status bar.

Parameters

[in] pMessage fly over message

See also: mdlOutput_printf

Remarks: Required Library: mdlbltin.lib

void mdlOutput_keyin ( WCharCP pMessage )

Displays the message designated by pMessage in the keyin field in the command window.

Parameters

[in] pMessage message to display

Remarks: A non-zero value for tcb->control.inh_err prevents mdlOutput_error from displaying messages.; A non-zero value for tcb->control.inh_msg prevents all other functions from displaying messages.

See also: mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_message mdlOutput_status

Remarks: Required Library: mdlbltin.lib

void mdlOutput_keyinU ( WCharCP pMessage )

Displays the message designated by pMessage in the keyin field in the command window, regardless of the state of tcb->control.inh_msg.

Parameters

[in] pMessage message to display

Remarks: See mdlOutput_commandU for a description of where messages are displayed with appropriate functions.; The flyover msg field DOES NOT EXIST in the command window. In the key-in area, it overlays the command prompt error field. This is the field where tool descriptions are displayed. It is erased automatically if a tool description is displayed, a prompt or error is displayed, or the user clicks in the status bar.

See also: mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_messageU mdlOutput_statusU

Remarks: Required Library: mdlbltin.lib

void mdlOutput_message ( WCharCP pMessage )

Displays the message designated by pMessage in the message field in the command window.

Parameters

[in] pMessage message to display

Remarks: A non-zero value for tcb->control.inh_err prevents mdlOutput_error from displaying messages.; A non-zero value for tcb->control.inh_msg prevents all other functions from displaying messages.

See also: mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status

Remarks: Required Library: mdlbltin.lib

int mdlOutput_messageCenter	(	DgnPlatform::OutputMessagePriority	messagePriority,
		WCharCP	pBriefMessage,
		WCharCP	pDetailedMessage,
		DgnPlatform::OutputMessageAlert	openAlertBox
	)

Sends the specified message and detailed message to the Message Center.

Parameters

[in]	messagePriority	determines which icon will be associated with the message in the Message Center's list box. Valid values are: OutputMessagePriority::Error, OutputMessagePriority::Error,OutputMessagePriority::Info, OutputMessagePriority::Debug
[in]	pBriefMessage	is the brief message string. This message will display in the Message Center and the Status Bar
[in]	pDetailedMessage	is optionally used to list any details associated with the message. This will display only in the Message Center.
[in]	openAlertBox	if true or OutputMessageAlert::Dialog, MicroStation will open an alert box displaying the brief message. If OutputMessageAlert::Balloon, a balloon window will be opened.

Returns: ERROR if an invalid priority is specified, SUCCESS otherwise

See also: mdlOutput_messageCenterC

Remarks: Required Library: mdlbltin.lib

int mdlOutput_messageCenterEx	(	DgnPlatform::OutputMessagePriority	messagePriority,
		WCharCP	pBriefMessage,
		WCharCP	pDetailedMessage,
		long	detailMessageAttributes,
		DgnPlatform::OutputMessageAlert	openAlertBox
	)

Sends the specified brief message and detailed message to the Message Center and specifies multi-line text item attributes for the Detailed Message area in the Message Center.

Parameters

[in]	messagePriority	determines which icon will be associated with the message in the Message Center's list box. Valid values are: OutputMessagePriority::Error, OutputMessagePriority::Error,OutputMessagePriority::Info, OutputMessagePriority::Debug
[in]	pBriefMessage	is the brief message string. This message will display in the Message Center and the Status Bar
[in]	pDetailedMessage	is optionally used to list any details associated with the message. This will display only in the Message Center.
[in]	detailMessageAttributes	specifies MLTEXTATTR_ values to be applied to the Detailed Message area before displaying the detailed message..
[in]	openAlertBox	if true or OutputMessageAlert::Dialog, MicroStation will open an alert box displaying the brief message. If OutputMessageAlert::Balloon, a balloon window will be opened.

Returns: ERROR if an invalid priority is specified, SUCCESS otherwise

See also: mdlOutput_messageCenterC mdlOutput_tempMessageC mdlOutput_rscMessageCenterC mdlOutput_rscvMessageCenterC

Remarks: Required Library: mdlbltin.lib

void mdlOutput_messageU ( WCharCP pMessage )

Displays the message designated by pMessage in the message field in the command window, regardless of the state of tcb->control.inh_msg.

Parameters

[in] pMessage message to display

Remarks: In the status area, the command window fields correspond to status area fields as follows:; See mdlOutput_commandU for a description of where messages are displayed with appropriate functions.; The flyover msg field DOES NOT EXIST in the command window. In the key-in area, it overlays the command prompt error field. This is the field where tool descriptions are displayed. It is erased automatically if a tool description is displayed, a prompt or error is displayed, or the user clicks in the status bar.

See also: mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_statusU

Remarks: Required Library: mdlbltin.lib

int mdlOutput_printf	(	int	type,
		WCharCP	formatP,
			...
	)

Displays a message in the command window field designated by type.

Valid values are MSG_MESSAGE, MSG_ERROR, MSG_PROMPT, MSG_STATUS, MSG_COMMAND and MSG_KEYIN.

Parameters

[in]	type	Identifies command window field
[in]	formatP	pointer to format string
[in]	...	arguments associated with conversion specifications in formatP

Remarks: The message is assembled according to the format specified by pFormat and using the values supplied by the variable argument list. The format string is a standard wprintf format string.

Returns: An integer specifying the number of bytes in the generated string.

See also: mdlOutput_vprintf mdlOutput_rscPrintf mdlOutput_rscvPrintf

Remarks: Required Library: mdlbltin.lib

void mdlOutput_prompt ( WCharCP pMessage )

Displays the message designated by pMessage in the prompt field in the command window.

Parameters

[in] pMessage message to display

Remarks: A non-zero value for tcb->control.inh_err prevents mdlOutput_error from displaying messages.; A non-zero value for tcb->control.inh_msg prevents all other functions from displaying messages.

See also: mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU mdlOutput_error mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status

Remarks: Required Library: mdlbltin.lib

void mdlOutput_promptU ( WCharCP pMessage )

Displays the message designated by pMessage in the prompt field in the command window, regardless of the status of tcb->control.inh_msg.

Parameters

[in] pMessage message to display

Remarks: See mdlOutput_commandU for a description of where messages are displayed with appropriate functions.; The flyover msg field DOES NOT EXIST in the command window. In the key-in area, it overlays the command prompt error field. This is the field where tool descriptions are displayed. It is erased automatically if a tool description is displayed, a prompt or error is displayed, or the user clicks in the status bar.

See also: mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status mdlOutput_errorU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU

Remarks: Required Library: mdlbltin.lib

int mdlOutput_rscfPrintf	(	FILE *	fp,
		RscFileHandle	resourceFileHandle,
		long	resourceId,
		int	stringNumber,
			...
	)

The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions.

The functions consist of a core of functionality that generates an output string based on a format string and a variable number of arguments. As with the mdlOutput_rscPrintf function, the resourceFileHandle, resourceId and stringNumber parameters identify a printf style format string.

Remarks: For mdlOutput_rscfPrintf and mdlOutput_rscvfPrintf, the generated string is written to the file identified by the fp parameter.; For mdlOutput_rscsPrintf and mdlOutput_rscvsPrintf, the generated string is copied to the buffer provided by the bufferP parameter.; For the mdlOutput_rscfPrintf and mdlOutput_rscsPrintf functions, the variable argument list is appended to the parameter list after the stringNumber parameter.; For the mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions, a variable argument list is passed along in the varg parameter. This is a standard method used when one function must receive a variable argument list and pass it on to another function.

Parameters

[in]	fp	file to write to
[in]	resourceFileHandle	The format string is retrieved from the resource file. resourceFileHandle specifies the resource file containing the MessageList.
[in]	resourceId	specifies the message list containing the string.
[in]	stringNumber	is the number of the string in the message list.
[in]	...	arguments associated with conversion specifications in the resource string

Remarks: The string resulting from interpreting the format string must have fewer than 600 characters.

Returns: An integer specifying the number of bytes in the generated string.

See also: mdlOutput_rscPrintf mdlOutput_rscvPrintf

Remarks: Required Library: mdlbltin.lib

int mdlOutput_rscMessageCenter	(	DgnPlatform::OutputMessagePriority	messagePriority,
		RscFileHandle	resourceFileHandle,
		long	resourceId,
		int	briefStringNumber,
		int	detailedStringNumber,
		DgnPlatform::OutputMessageAlert	openAlertBox,
			...
	)

Loads the specified brief message and detailed message from the resource file and sends them to the Message Center.

Parameters

[in]	messagePriority	determines which icon will be associated with the message in the Message Center's list box. Valid values are: OutputMessagePriority::Error, OutputMessagePriority::Error, OutputMessagePriority::Info, OutputMessagePriority::Debug
[in]	resourceFileHandle	resource file from which to load messages
[in]	resourceId	is the id of string list containing the messages.
[in]	briefStringNumber	is index of the message string.
[in]	detailedStringNumber	is the index of the detailed message text.
[in]	openAlertBox	if true or OutputMessageAlert::Dialog, MicroStation will open an alert box displaying the brief message. If OutputMessageAlert::Balloon, a balloon window will be opened.
[in]	...	arguments associated with conversion specifications in the resource string

Returns: ERROR if an invalid priority is specified, SUCCESS otherwise

See also: mdlOutput_messageCenterExC mdlOutput_tempMessageC mdlOutput_messageCenterC mdlOutput_rscvMessageCenterC

Remarks: Required Library: mdlbltin.lib

int mdlOutput_rscPrintf	(	int	type,
		RscFileHandle	resourceFileHandle,
		long	resourceId,
		int	stringNumber,
			...
	)

Displays a message in the command window field designated by type.

The message is assembled according to the format specified by the string in a MessageList resource. The values substituted into the string are passed as arguments.

Parameters

[in]	type	MSG_MESSAGE, MSG_PROMPT, etc
[in]	resourceFileHandle	The format string is retrieved from the resource file. resourceFileHandle specifies the resource file containing the MessageList.
[in]	resourceId	specifies the message list containing the string.
[in]	stringNumber	is the number of the string in the message list.
[in]	...	arguments associated with conversion specifications in the resource string

Remarks: The string resulting from interpreting the format string must have fewer than 600 characters.

Returns: An integer specifying the number of bytes in the generated string.

See also: mdlOutput_vprintf mdlOutput_printf

Remarks: Required Library: mdlbltin.lib

void mdlOutput_rscsPrintf	(	WStringR	outStr,
		RscFileHandle	resourceFileHandle,
		long	resourceId,
		int	stringNumber,
			...
	)

The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions.

The functions consist of a core of functionality that generates an output string based on a format string and a variable number of arguments. As with the mdlOutput_rscPrintf function, the resourceFileHandle, resourceId and stringNumber parameters identify a printf style format string.

Remarks: For mdlOutput_rscfPrintf and mdlOutput_rscvfPrintf, the generated string is written to the file identified by the fp parameter.; For mdlOutput_rscsPrintf and mdlOutput_rscvsPrintf, the generated string is copied to the buffer provided by the bufferP parameter.; For the mdlOutput_rscfPrintf and mdlOutput_rscsPrintf functions, the variable argument list is appended to the parameter list after the stringNumber parameter.; For the mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions, a variable argument list is passed along in the varg parameter. This is a standard method used when one function must receive a variable argument list and pass it on to another function.

Parameters

[out]	outStr	buffer for generated string
[in]	resourceFileHandle	The format string is retrieved from the resource file. resourceFileHandle specifies the resource file containing the MessageList.
[in]	resourceId	specifies the message list containing the string.
[in]	stringNumber	is the number of the string in the message list.
[in]	...	arguments associated with conversion specifications in the resource string

See also: mdlOutput_rscPrintf mdlOutput_rscvPrintf

Remarks: Required Library: mdlbltin.lib

int mdlOutput_rscvfPrintf	(	FILE *	fp,
		RscFileHandle	resourceFileHandle,
		long	resourceId,
		int	stringNumber,
		va_list	varg
	)

The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions.

The functions consist of a core of functionality that generates an output string based on a format string and a variable number of arguments. As with the mdlOutput_rscPrintf function, the resourceFileHandle, resourceId and stringNumber parameters identify a printf style format string.

Remarks: For mdlOutput_rscfPrintf and mdlOutput_rscvfPrintf, the generated string is written to the file identified by the fp parameter.; For mdlOutput_rscsPrintf and mdlOutput_rscvsPrintf, the generated string is copied to the buffer provided by the bufferP parameter.; For the mdlOutput_rscfPrintf and mdlOutput_rscsPrintf functions, the variable argument list is appended to the parameter list after the stringNumber parameter.; For the mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions, a variable argument list is passed along in the varg parameter. This is a standard method used when one function must receive a variable argument list and pass it on to another function.

Parameters

[in]	fp	file to write to
[in]	resourceFileHandle	The format string is retrieved from the resource file. resourceFileHandle specifies the resource file containing the MessageList.
[in]	resourceId	specifies the message list containing the string.
[in]	stringNumber	is the number of the string in the message list.
[in]	varg	a variable argument list

Remarks: The string resulting from interpreting the format string must have fewer than 600 characters.

Returns: An integer specifying the number of bytes in the generated string.

See also: mdlOutput_rscPrintf mdlOutput_rscvPrintf

Remarks: Required Library: mdlbltin.lib

int mdlOutput_rscvMessageCenter	(	DgnPlatform::OutputMessagePriority	messagePriority,
		RscFileHandle	resourceFileHandle,
		long	resourceId,
		int	briefStringNumber,
		int	detailedStringNumber,
		DgnPlatform::OutputMessageAlert	openAlertBox,
		va_list	varg
	)

Loads the specified brief message and detailed message from the resource file and sends them to the Message Center.

Parameters

[in]	messagePriority	determines which icon will be associated with the message in the Message Center's list box. Valid values are: OutputMessagePriority::Error, OutputMessagePriority::Error, OutputMessagePriority::Info, OutputMessagePriority::Debug
[in]	resourceFileHandle	resource file from which to load messages
[in]	resourceId	is the id of string list containing the messages.
[in]	briefStringNumber	is index of the message string.
[in]	detailedStringNumber	is the index of the detailed message text.
[in]	openAlertBox	if true or OutputMessageAlert::Dialog, MicroStation will open an alert box displaying the brief message. If OutputMessageAlert::Balloon, a balloon window will be opened.
[in]	varg	a variable argument list

Returns: ERROR if an invalid priority is specified, SUCCESS otherwise

See also: mdlOutput_messageCenterExC mdlOutput_tempMessageC mdlOutput_rscMessageCenterC mdlOutput_messageCenterC

Remarks: Required Library: mdlbltin.lib

int mdlOutput_rscvPrintf	(	int	type,
		RscFileHandle	resourceFileHandle,
		long	resourceId,
		int	stringNumber,
		va_list	varg
	)

The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions.

The functions consist of a core of functionality that generates an output string based on a format string and a variable number of arguments. As with the mdlOutput_rscPrintf function, the resourceFileHandle, resourceId and stringNumber parameters identify a printf style format string.

Remarks: For mdlOutput_rscfPrintf and mdlOutput_rscvfPrintf, the generated string is written to the file identified by the fp parameter.; For mdlOutput_rscsPrintf and mdlOutput_rscvsPrintf, the generated string is copied to the buffer provided by the bufferP parameter.; For the mdlOutput_rscfPrintf and mdlOutput_rscsPrintf functions, the variable argument list is appended to the parameter list after the stringNumber parameter.; For the mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions, a variable argument list is passed along in the varg parameter. This is a standard method used when one function must receive a variable argument list and pass it on to another function.

Parameters

[in]	type	MSG_MESSAGE, MSG_PROMPT, etc
[in]	resourceFileHandle	The format string is retrieved from the resource file. resourceFileHandle specifies the resource file containing the MessageList.
[in]	resourceId	specifies the message list containing the string.
[in]	stringNumber	is the number of the string in the message list.
[in]	varg	a variable argument list

Remarks: The string resulting from interpreting the format string must have fewer than 600 characters.

Returns: An integer specifying the number of bytes in the generated string.

See also: mdlOutput_rscPrintf

Remarks: Required Library: mdlbltin.lib

void mdlOutput_rscvsPrintf	(	WStringR	buffer,
		RscFileHandle	resourceFileHandle,
		long	resourceId,
		int	stringNumber,
		va_list	varg
	)

The mdlOutput_rscfPrintf, mdlOutput_rscsPrintf, mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions round out the mdlOutput_rscPrintf functions the same way fprintf, sprintfv, fprintf and vsprintf round out the printf class of functions.

The functions consist of a core of functionality that generates an output string based on a format string and a variable number of arguments. As with the mdlOutput_rscPrintf function, the resourceFileHandle, resourceId and stringNumber parameters identify a printf style format string.

Remarks: For mdlOutput_rscfPrintf and mdlOutput_rscvfPrintf, the generated string is written to the file identified by the fp parameter.; For mdlOutput_rscsPrintf and mdlOutput_rscvsPrintf, the generated string is copied to the buffer provided by the bufferP parameter.; For the mdlOutput_rscfPrintf and mdlOutput_rscsPrintf functions, the variable argument list is appended to the parameter list after the stringNumber parameter.; For the mdlOutput_rscvfPrintf and mdlOutput_rscvsPrintf functions, a variable argument list is passed along in the varg parameter. This is a standard method used when one function must receive a variable argument list and pass it on to another function.

Parameters

[out]	buffer	buffer for generated string
[in]	resourceFileHandle	The format string is retrieved from the resource file. resourceFileHandle specifies the resource file containing the MessageList.
[in]	resourceId	specifies the message list containing the string.
[in]	stringNumber	is the number of the string in the message list.
[in]	varg	a variable argument list

Remarks: The string resulting from interpreting the format string must have fewer than 600 characters.

Returns: An integer specifying the number of bytes in the generated string.

See also: mdlOutput_rscPrintf mdlOutput_rscvPrintf

Remarks: Required Library: mdlbltin.lib

void mdlOutput_setAddToMessageCenter ( bool bMsgCenter )

Toggles on or off the Message Center logging.

Remarks: This function should be used only as an absolute last resort! Use mdlOutput_tempMessage instead.

Parameters

[in] bMsgCenter should be set to false to disable logging, true to enable logging

Remarks: Required Library: mdlbltin.lib

void mdlOutput_status ( WCharCP pMessage )

Displays the message designated by pMessage in the status field in the command window.

Remarks: A non-zero value for tcb->control.inh_err prevents mdlOutput_error from displaying messages.; A non-zero value for tcb->control.inh_msg prevents all other functions from displaying messages.

Parameters

[in] pMessage the message to display

See also: mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU mdlOutput_statusU mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message

Remarks: Required Library: mdlbltin.lib

void mdlOutput_statusU ( WCharCP pMessage )

Displays the message designated by pMessage of the status field

in the command window, regardless of the state if tcb->control.inh_msg.

Parameters

[in] pMessage the message to display

Remarks: See mdlOutput_commandU for a description of where messages are displayed with appropriate functions.; The flyover msg field DOES NOT EXIST in the command window. In the key-in area, it overlays the command prompt error field. This is the field where tool descriptions are displayed. It is erased automatically if a tool description is displayed, a prompt or error is displayed, or the user clicks in the status bar.

See also: mdlOutput_error mdlOutput_prompt mdlOutput_command mdlOutput_keyin mdlOutput_message mdlOutput_status mdlOutput_errorU mdlOutput_promptU mdlOutput_commandU mdlOutput_keyinU mdlOutput_messageU

Remarks: Required Library: mdlbltin.lib

int mdlOutput_tempMessage	(	DgnPlatform::OutputMessagePriority	messageField,
		WCharCP	pBriefMessage,
		WCharCP	pDetailedMessage
	)

Sends the specified brief message and detailed message to the Message Center, but the messages are only temporary.

Instead of becoming a permanent part of the log, the messages will be overlaid by the next message sent to the Message Center..

Parameters

[in]	messageField	determines where in the Status Bar the brief message will display. OutputMessagePriority::TempLeft specifies the Command/Prompt (far left) area. OutputMessagePriority::TempRight specifies the Message (center) area.
[in]	pBriefMessage	is the brief message string. This message will display in the Message Center and the Status Bar
[in]	pDetailedMessage	is optionally used to list any details associated with the message. This will display only in the Message Center.

Returns: ERROR if an invalid messageField is specified, SUCCESS otherwise

See also: mdlOutput_messageCenterExC mdlOutput_messageCenterC mdlOutput_rscMessageCenterC mdlOutput_rscvMessageCenterC

Remarks: Required Library: mdlbltin.lib

int mdlOutput_vprintf	(	int	type,
		WCharCP	formatP,
		va_list	ap
	)

Displays a message in the command window field designated by type.

Parameters

[in] type type of field. Valid values are MSG_MESSAGE, MSG_ERROR, MSG_PROMPT, MSG_STATUS, MSG_COMMAND and MSG_KEYIN, which are defined in mdl.h.

Remarks: The message is assembled according to the format specified by pFormat using the values specified by varArgList. See the documentation of printf for a list of supported format specifiers.

Parameters

[in]	formatP	pointer to format string
[in]	ap	The string resulting from interpreting the format string can be of unlimited length; it is no longer limited.

Returns: An integer specifying the number of bytes in the generated string.

See also: mdlOutput_printf mdlOutput_rscPrintf mdlOutput_rscvPrintf

Remarks: Required Library: mdlbltin.lib

Modules

Functions

Detailed Description

Function Documentation