Functions
int	mdlDialog_fileOpenExt (BeFileNameR fileName, FileOpenExtraInfo extraInfoP, FileOpenParams paramsP, int attributes)
	Displays a Dialog Box that lets the user select a file to open or create. More...

int	mdlDialog_openAdvisoryBox (RscId dialogId, WCharCP titleP, WCharCP stringP, MessageBoxIconType whichIcon)
	Presents a message that cannot be dismissed. More...

void	mdlDialog_balloonTextShow (MSDialogP dbP, Point2dCP cursorPt, bool showBalloon, WCharCP displayText, BSIRectCP localItemRectP, Point2dCP originPtP, int fontIndex, BSIColorDescrCP textColorP)
	Displays or hides the tooltip window. More...

StatusInt	mdlDialog_hookDialogGetSecondary (MdlDescP dialogHookMDP, PFDialogBoxHook dialogHookFuncP, MSDialogP dbP)
	Gets the secondary hook information for a Dialog Box. More...

StatusInt	mdlDialog_hookDialogSetSecondary (MSDialogP dbP, PFDialogBoxHook dialogHookFuncP, DialogHookInterests *pHookInterests)
	Sets/Adds at secondary hook to the Dialog Box. More...

StatusInt	mdlDialog_hookDialogRemoveSecondary (MSDialogP dbP, PFDialogBoxHook pFunc)
	Removes a secondary hook from a Dialog Box. More...

StatusInt	mdlDialog_addHookHandler (MSDialogP dbP, DialogHookHandler pHandler, DialogHookInterests pHookInterests)
	Adds a dialog hook handler to the Dialog Box. More...

StatusInt	mdlDialog_hookItemSetByDescr (RawItemHdrP riP, PFDialogItemHook pFunc, MdlDescP mdlDescP)
	Sets the hook information for a dialog item. More...

void	mdlDialog_adjustPopDownHeight (MSDialogP dbP)
	Adjusts the width and height of the Tool Settings window after hiding or showing items in the Command Item List. More...

void	mdlDialog_toolSettingsAdjustWidthAndHeight ()
	Adjusts the width and height of the Tool Settings window after hiding or showing items in the Command Item List. More...

int	mdlDialog_itemGetCancel (MSDialogP dbP)
	Gets the index of the cancel button for the specified dialog. More...

int	mdlDialog_itemGetDefault (MSDialogP dbP)
	Gets the index of the default button for the specified dialog. More...

bool	mdlDialog_itemIsValid (DialogItemP diP)
	Validates a DialogItem pointer. More...

void	mdlDialog_beep (int tone, int ticks, int rept)
	Beeps at given tone for a given number of ticks. More...

MSDialogP	mdlDialog_overallTitleBarGet (void)
	Returns a pointer of the Dialog Box containing MicroStation's overall application title and main menu. More...

MSDialogP	mdlDialog_keyinWindowGet (void)
	Returns a MSDialog pointer of the main key-in area, which can be referenced without having to consider the currently selected interface style. More...

MSDialogP	mdlDialog_statusAreaGet (void)
	Returns a pointer of the Dialog Box containing the current snap icon, active level, etc. More...

void	mdlDialog_dmsgsClear (void)
	Clears the "Messages" Dialog Box. More...

void	mdlDialog_dmsgsGetPrintState (UInt32 *bypassMessagesP)
	Gets the print state of the "Messages" Dialog Box. More...

void	mdlDialog_dmsgsPrintA (char *stringP)
	Allows application developers to display status or diagnostic messages to the Dialog Manager's Messages Dialog Box. More...

void	mdlDialog_dmsgsPrint (WCharCP stringP)
	Allows application developers to display status or diagnostic messages to the Dialog Manager's Messages Dialog Box. More...

void	mdlDialog_dmsgsPrintDialogMsg (DialogMessage *dmP, bool filterCommandWindow)
	Displays information on the dialog message dmP in the "Messages" Dialog Box. More...

void	mdlDialog_dmsgsPrintItemMsg (DialogItemMessage *dimP, bool filterCommandWindow, bool fromHookFunction)
	Displays information on the dialog item message dimP in the "Messages" Dialog Box. More...

void	mdlDialog_dmsgsSet (bool dialogMessages, bool itemHookMessages, bool itemHandlerMessages, bool verboseMessages)
	Controls which types of messages for which information will be displayed. More...

void	mdlDialog_dmsgsSetPrintState (UInt32 bypassMessages)
	Sets the print state of the "Messages" Dialog Box. More...

void	mdlDialog_dump (MSDialogP dbP)
	Displays diagnostic information about a Dialog Box and its constituent items. More...

bool	mdlDialog_isValidDialog (MSDialogP dbP)
	Determines the validity of a MSDialog pointer. More...

bool	mdlDialog_isFocusable (MSDialogP dbP)
	Returns the focusable state of a Dialog Box. More...

bool	mdlDialog_isUstnTaskIdP (WCharCP taskIdP)
	Determines whether a task is the main (Ustn) Task Id. More...

StatusInt	mdlDialog_userPrefFileOpen (RscFileHandle *userPrefHP, int readWriteAccess)
	Obtains a resource file handle corresponding to the active user preferences file for the current MicroStation session. More...

void *	mdlDialog_fixResourceAddress (byte resP, byte memberP, size_t sizeMember)
	Obtains a properly aligned pointer to a structure member within a resource. More...

StatusInt	mdlDialog_itemHandlerFind (MdlDescP mdlDescP, void(mdlFunc)(DialogItemMessage ), RscType itemType)
	Retrieves certain information about a dialog item handler. More...

StatusInt	mdlDialog_itemHandlerGetInfo (DialogItemHandlerInfo **itemHandlerPP, RscType itemType)
	Retrieves certain information about a dialog item handler. More...

StatusInt	mdlDialog_nativeItemHandlerPublishByMdlDesc (int nHandlers, DialogItemHandler *pHandlers)
	Publishes dialog item handlers based on data in an array of DialogItemHandler structures. More...

int	mdlDialog_itemGetType (DialogItemP diP)
	Returns the type of the dialog item. More...

int	mdlDialog_itemGetID (DialogItemP diP)
	Returns the resource ID of the dialog item. More...

RawItemHdrP	mdlDialog_itemGetRawItemHdr (DialogItemP diP)
	Returns a pointer to the item's raw item header. More...

DialogItemP	mdlDialog_rItemGetDialogItem (RawItemHdrP riP)
	Returns a pointer to the raw item's dialog item. More...

int	mdlDialog_getID (MSDialogP dbP)
	Returns the resource ID of the dialog box. More...

Detailed Description

Function Documentation

StatusInt mdlDialog_addHookHandler	(	MSDialogP	dbP,
		DialogHookHandler *	pHandler,
		DialogHookInterests *	pHookInterests
	)

Adds a dialog hook handler to the Dialog Box.

Parameters

[in]	dbP	Dialog Box with a secondary hook
[in]	pHandler	pointer to the hook handler
[in]	pHookInterests	flags representing which events the the handler will be notified about

Returns: SUCCESS or ERROR

Remarks: Required Library: mdlbltin.lib

void mdlDialog_adjustPopDownHeight ( MSDialogP dbP )

Adjusts the width and height of the Tool Settings window after hiding or showing items in the Command Item List.

Parameters

[in] dbP The Tool Settings Dialog. Get the Tool Settings window by calling mdlDialog_getToolSettings.

Remarks: Required Library: mdlbltin.lib

void mdlDialog_balloonTextShow	(	MSDialogP	dbP,
		Point2dCP	cursorPt,
		bool	showBalloon,
		WCharCP	displayText,
		BSIRectCP	localItemRectP,
		Point2dCP	originPtP,
		int	fontIndex,
		BSIColorDescrCP	textColorP
	)

Displays or hides the tooltip window.

Parameters

[in]	dbP	Dialog the cursor & origin are relative to
[in]	cursorPt	Origin of the cursor
[in]	showBalloon	true means open, false to CLOSE
[in]	displayText	Text to display
[in]	localItemRectP	Rect of item, used if originPt not specified
[in]	originPtP	Override Origin of the Balloon Popup
[in]	fontIndex	FontIndex to be used for text
[in]	textColorP	Color of text

Remarks: Required Library: mdlbltin.lib

void mdlDialog_beep	(	int	tone,
		int	ticks,
		int	rept
	)

Beeps at given tone for a given number of ticks.

Parameters

[in]	tone	the tone in Hz
[in]	ticks	the duration of each beep
[in]	rept	the number of repititions

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dmsgsClear ( void )

Clears the "Messages" Dialog Box.

It takes no arguments.

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dmsgsGetPrintState ( UInt32 * bypassMessagesP )

Gets the print state of the "Messages" Dialog Box.

Parameters

[out] bypassMessagesP receives the "messages bypassed" flags

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dmsgsPrint ( WCharCP stringP )

Allows application developers to display status or diagnostic messages to the Dialog Manager's Messages Dialog Box.

If the Messages Dialog Box is not already visible on the screen, calling this function will make it so.

Parameters

[in] stringP is a free-form string to display in the Dialog Manager's Messages Dialog Box.

See also: mdlDialog_dump

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dmsgsPrintA ( char * stringP )

Allows application developers to display status or diagnostic messages to the Dialog Manager's Messages Dialog Box.

If the Messages Dialog Box is not already visible on the screen, calling this function will make it so.

Parameters

[in] stringP is a free-form string to display in the Dialog Manager's Messages Dialog Box.

See also: mdlDialog_dump

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dmsgsPrintDialogMsg	(	DialogMessage *	dmP,
		bool	filterCommandWindow
	)

Displays information on the dialog message dmP in the "Messages" Dialog Box.

It can be used to display information on messages that are being sent to a particular dialog hook function. The last parameter should always be true.

Parameters

[in]	dmP	dialog messag to print
[in]	filterCommandWindow	always set to true

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dmsgsPrintItemMsg	(	DialogItemMessage *	dimP,
		bool	filterCommandWindow,
		bool	fromHookFunction
	)

Displays information on the dialog item message dimP in the "Messages" Dialog Box.

It can be used to display information on messages that are being sent to a particular item hook function. The last two parameters should always be set to true.

Parameters

[in]	dimP	dialog item message to print
[in]	filterCommandWindow	always set to true
[in]	fromHookFunction	always set to true

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dmsgsSet	(	bool	dialogMessages,
		bool	itemHookMessages,
		bool	itemHandlerMessages,
		bool	verboseMessages
	)

Controls which types of messages for which information will be displayed.

Set the dialogMessages, itemHookMessages or itemHandlerMessages parameter to true to display information for those types of messages. Set verbose to true to turn on detailed information for any displayed messages.

Parameters

[in]	dialogMessages	display dialog hook messages?
[in]	itemHookMessages	display item hook messages?
[in]	itemHandlerMessages	display item handler messages?
[in]	verboseMessages	display msg details

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dmsgsSetPrintState ( UInt32 bypassMessages )

Sets the print state of the "Messages" Dialog Box.

Parameters

[in] bypassMessages the "messages bypassed" flags

Remarks: Required Library: mdlbltin.lib

void mdlDialog_dump ( MSDialogP dbP )

Displays diagnostic information about a Dialog Box and its constituent items.

The information is displayed in the Dialog Manager's messages Dialog Box. If the messages Dialog Box is not already visible, calling this function will make it so. This is a debugging tool.

Parameters

[in] dbP is the Dialog Box about which information will be displayed.

See also: mdlDialog_dmsgsPrintA

Remarks: Required Library: mdlbltin.lib

int mdlDialog_fileOpenExt	(	BeFileNameR	fileName,
		FileOpenExtraInfo *	extraInfoP,
		FileOpenParams *	paramsP,
		int	attributes
	)

Displays a Dialog Box that lets the user select a file to open or create.

The mdlDialog_fileOpenExt function can be used in place of mdlDialog_fileOpen, mdlDialog_fileCreate, mdlDialog_defFileOpen, mdlDialog_defFileCreate and mdlDialog_fileCreateFromSeed.

Parameters

[out]	fileName	returns the name of the file to be opened or created. On Open, fileNameP will be an existing file. On Create, if the file exists, an alert will display asking the user if the existing file should be overwritten. If the user chooses CANCEL, the user can choose another file name. If the user chooses OK, the file name will be returned.
[out]	extraInfoP	returns additional information about the selected file. This structure will contain the name of the configuration variable used to select a directory (as in attaching a reference file) or the name of the seed file that should be used to create a file (as in creating a new design file). If this information is not needed, pass NULL.
[in]	paramsP	is a structure containing file open parameters. The entire structure should be memset to 0 and then individual fields set as necessary.
[in]	attributes	file open dialog attributes

Returns: true if the CANCEL button is pressed, false if the OK button is pressed, and ERROR if an error occurred while the Dialog Box was being created.

See also: mdlDialog_fileOpen mdlDialog_fileCreate mdlDialog_defFileOpen mdlDialog_defFileCreate mdlDialog_fileCreateFromSeed mdlFileList_edit mdlSystem_getCurrMdlDesc

Remarks: Required Library: mdlbltin.lib

void* mdlDialog_fixResourceAddress	(	byte *	resP,
		byte *	memberP,
		size_t	sizeMember
	)

Obtains a properly aligned pointer to a structure member within a resource.

This function is useful for traversing resources which contain variable sized arrays (variable sized arrays make static dereferences impossible). The function uses three parameters to accomplish this as follows:

Parameters

[in]	resP	the base address of the resource, is subtracted from memberP, the caller's best guess at the location of the desired structure member. This calculates the effective offset of the "best guess" relative to the beginning of the resource. ("Best guess" means the caller calculated the address without taking padding or alignment considerations into account).
[in]	memberP	address of member that may need alignment fixing
[in]	sizeMember	The third argument, the proposed alignment of the target member, is used to adjust the caller's proposed member offset required by the current hardware platform. That adjusted pointer is returned to the caller.

Returns: The address of the desired resource member.

Remarks: Required Library: mdlbltin.lib

int mdlDialog_getID ( MSDialogP dbP )

Returns the resource ID of the dialog box.

Parameters

[in] dbP a pointer to the MSDialog

Returns: The resource type of the dialog box.

Remarks: Required Library: mdlbltin.lib; Code that can use C data structures does not need this. This function is provided to support languages such as VBA that can not use complicated C data structures.

StatusInt mdlDialog_hookDialogGetSecondary	(	MdlDescP *	dialogHookMDP,
		PFDialogBoxHook *	dialogHookFuncP,
		MSDialogP	dbP
	)

Gets the secondary hook information for a Dialog Box.

Parameters

[out]	dialogHookMDP	Receives the MDL Descriptor for the secondary hook
[out]	dialogHookFuncP	Receives the hook function pointer for the secondary hook
[in]	dbP	Dialog Box with a secondary hook

Returns: SUCCESS or ERROR

Remarks: Required Library: mdlbltin.lib

StatusInt mdlDialog_hookDialogRemoveSecondary	(	MSDialogP	dbP,
		PFDialogBoxHook	pFunc
	)

Removes a secondary hook from a Dialog Box.

Parameters

[in]	dbP	Dialog Box with a secondary hook
[in]	pFunc	pointer to the secondary hook function

Returns: SUCCESS or ERROR

Remarks: Required Library: mdlbltin.lib

StatusInt mdlDialog_hookDialogSetSecondary	(	MSDialogP	dbP,
		PFDialogBoxHook	dialogHookFuncP,
		DialogHookInterests *	pHookInterests
	)

Sets/Adds at secondary hook to the Dialog Box.

Parameters

[in]	dbP	Dialog Box with a secondary hook
[in]	dialogHookFuncP	pointer to the secondary hook function
[in]	pHookInterests	flags representing which events the secondary hook will be notified about

Returns: SUCCESS or ERROR

Remarks: Required Library: mdlbltin.lib

StatusInt mdlDialog_hookItemSetByDescr	(	RawItemHdrP	riP,
		PFDialogItemHook	pFunc,
		MdlDescP	mdlDescP
	)

Sets the hook information for a dialog item.

Parameters

[in]	riP	RawItemHdr pointer of a dialog item
[in]	pFunc	pointer to the secondary hook function
[in]	mdlDescP	The MDL Descriptor of the application

Returns: SUCCESS or ERROR

Remarks: Required Library: mdlbltin.lib

bool mdlDialog_isFocusable ( MSDialogP dbP )

Returns the focusable state of a Dialog Box.

Parameters

[in] dbP is the Dialog Box to check for focusability.

Returns: true if the dialog is focusable, or false otherwise.

Remarks: Required Library: mdlbltin.lib

bool mdlDialog_isUstnTaskIdP ( WCharCP taskIdP )

Determines whether a task is the main (Ustn) Task Id.

Parameters

[in] taskIdP Task Id to check against Ustn TaskId.

Returns: true if taskIdP points to the Ustn TaskId, or false otherwise

Remarks: Required Library: mdlbltin.lib

bool mdlDialog_isValidDialog ( MSDialogP dbP )

Determines the validity of a MSDialog pointer.

Parameters

[in] dbP is the MSDialog to validate.

Returns: true if the MSDialog is valid, or false otherwise.

Remarks: Required Library: mdlbltin.lib

int mdlDialog_itemGetCancel ( MSDialogP dbP )

Gets the index of the cancel button for the specified dialog.

Parameters

[in] dbP a pointer to the Dialog Box

Returns: The index of the cancel button or -1 if there is none or an error occurs

Remarks: Required Library: mdlbltin.lib

int mdlDialog_itemGetDefault ( MSDialogP dbP )

Gets the index of the default button for the specified dialog.

Parameters

[in] dbP a pointer to the Dialog Box

Returns: The index of the default button or -1 if there is none or an error occurs

Remarks: Required Library: mdlbltin.lib

int mdlDialog_itemGetID ( DialogItemP diP )

Returns the resource ID of the dialog item.

Parameters

[in] diP a pointer to the DialogItem

Returns: The resource ID of the dialog item.

Remarks: Required Library: mdlbltin.lib; Code that can use C data structures does not need this. This function is provided to support languages such as VBA that can not use complicated C data structures.

RawItemHdrP mdlDialog_itemGetRawItemHdr ( DialogItemP diP )

Returns a pointer to the item's raw item header.

Parameters

[in] diP a pointer to the DialogItem

Returns: The item's raw item header.

Remarks: Required Library: mdlbltin.lib; Code that can use C data structures does not need this. This function is provided to support languages such as VBA that can not use complicated C data structures.

int mdlDialog_itemGetType ( DialogItemP diP )

Returns the type of the dialog item.

Parameters

[in] diP a pointer to the DialogItem

Returns: The resource type of the dialog item.

Remarks: Required Library: mdlbltin.lib; Code that can use C data structures does not need this. This function is provided to support languages such as VBA that can not use complicated C data structures.

StatusInt mdlDialog_itemHandlerFind	(	MdlDescP *	mdlDescP,
		void(*)(DialogItemMessage )	mdlFunc,
		RscType	itemType
	)

Retrieves certain information about a dialog item handler.

Parameters

[in]	mdlDescP	pointer used to retrieve a pointer to the Mdl Descriptor of the item handler
[in]	mdlFunc	pointer used to retrieve the function pointer of the item handler
[in]	itemType	RTYPE of the dialog item. These types are defined in rtypes.r.h.

Returns: SUCCESS if the item is found or ERROR if not member.

See also: mdlDialog_itemHandlerGetInfo

Remarks: Required Library: mdlbltin.lib

StatusInt mdlDialog_itemHandlerGetInfo	(	DialogItemHandlerInfo **	itemHandlerPP,
		RscType	itemType
	)

Retrieves certain information about a dialog item handler.

Parameters

[in]	itemHandlerPP	pointer used to retrieve a pointer to a DialogItemHandlerInfo containing information about an item handler. DialogItemHandlerInfo is defined in dlogitem.h.
[in]	itemType	RTYPE of the dialog item. These types are defined in rtypes.r.h.

Returns: SUCCESS if the item is found or ERROR if not member.

See also: mdlDialog_itemHandlerFind

Remarks: Required Library: mdlbltin.lib

bool mdlDialog_itemIsValid ( DialogItemP diP )

Validates a DialogItem pointer.

Parameters

[in] diP a pointer to the DialogItem

Returns: true is the DialogItem pointer is valid, or false if not

MSDialogP mdlDialog_keyinWindowGet ( void )

Returns a MSDialog pointer of the main key-in area, which can be referenced without having to consider the currently selected interface style.

Returns: A pointer to the MSDialog that contains the main key-in area. In the command window style interface, this function returns a pointer to the command window. In the status bar style interface, this function returns a pointer to the key-in dialog if it is open and NULL otherwise.

See also: mdlDialog_commandWindowGet mdlDialog_statusAreaGet mdlDialog_overallTitleBarGet mdlDialog_menuBarGetCmdWinP

Remarks: Required Library: mdlbltin.lib

StatusInt mdlDialog_nativeItemHandlerPublishByMdlDesc	(	int	nHandlers,
		DialogItemHandler *	pHandlers
	)

Publishes dialog item handlers based on data in an array of DialogItemHandler structures.

The DialogItemHandler structure is defined in dlogitem.h.

Parameters

[in]	nHandlers	the number of handler structures in the array containing information about an item handler. DialogItemHandlerInfo is defined in dlogitem.h.
[in]	pHandlers	points to an array DialogItemHandler structures containing information about dialog item handlers.

Returns: SUCCESS if the items are published, else ERROR.

See also: mdlDialog_itemHandlerFind

Remarks: Required Library: mdlbltin.lib

int mdlDialog_openAdvisoryBox	(	RscId	dialogId,
		WCharCP	titleP,
		WCharCP	stringP,
		MessageBoxIconType	whichIcon
	)

Presents a message that cannot be dismissed.

Once opened, it will stay visible until the current drawing is closed.

Parameters

[in]	dialogId	DialogId of AdvisoryBox
[in]	titleP	string to display in title, NULL for default
[in]	stringP	string to display in alert, NULL for default
[in]	whichIcon	ID of icon to be displayed in box. 0 indicates no icon, or one of the MSGBOX_ICON_... IDs from dlogitem.h indicates which icon to use.

Returns: SUCCESS or ERROR.

Remarks: Typically, an application operating as a MS_DGNAPPS will hook the SYSTEM_NEWFILE_COMPLETE event in the SYSTEM_NEW_DESIGN_FILE asynchronous function. An example advisory resource is shown below. The published hook "HOOKDIALOGID_AdvisoryBox" must be used to obtain the necessary hook processing. The attribute DIALOGATTR_DOCKABLE in combination with this hook processing causes the dialog to always stay within the window area. If DIALOGATTR_DOCKABLE is not used, the dialog may be moved past the edges of the main window.
-----------------------------------------------------------------+

| |

| Sample Advisory Dialog |

| |

+----------------------------------------------------------------

#undef XC

#define XC (DCOORD_RESOLUTION/2) * ASPECT_ADVISORYBOX

#define XSIZE 50*XC

#define YSIZE 10*YC

DialogBoxRsc DIALOGID_Advisory=

{

DIALOGATTR_DOCKABLE|DIALOGATTR_UNCLOSEABLE|DIALOGATTR_NORIGHTICONS,

XSIZE, YSIZE, NOHELP, MHELPTOPIC, HOOKDIALOGID_AdvisoryBox,

NOPARENTID,

"A Default Title",

{

{{10*XC,YC,35*XC,0}, MLText, MLTEXTID_Advisory, ON, 0, "", ""},

{{GENX,GENY(2),5*XC,5*YC},Generic,GENERICID_WarningIcon,ON,0,"",""},

}

};

DItem_MultilineTextRsc MLTEXTID_Advisory=

{

NOSYNONYM, NOHELP, LHELPTOPIC, NOHOOK, NOARG,

MLTEXTATTR_READONLY | MLTEXTATTR_NODISPLAYNLCHAR |

MLTEXTATTR_AUTOHIDEDECOR, 10,""

};

DItem_GenericRsc GENERICID_WarningIcon =

{

NOHELP, MHELPTOPIC, HOOKITEMID_Generic_WarningIcon, NOARG

};

See also: mdlDialog_openMessageBox mdlSystem_setFunction

Remarks: Required Library: mdlbltin.lib

MSDialogP mdlDialog_overallTitleBarGet ( void )

Returns a pointer of the Dialog Box containing MicroStation's overall application title and main menu.

This function is not typically needed. The mdlDialog_menuBarGetCmdWinP function should be used if an application needs to dynamically alter MicroStation's main menu.

Returns: A pointer to the MSDialog that houses the overall application title and main menu.

See also: mdlDialog_commandWindowGet mdlDialog_keyinWindowGet mdlDialog_statusAreaGet mdlDialog_menuBarGetCmdWinP

Remarks: Required Library: mdlbltin.lib

DialogItemP mdlDialog_rItemGetDialogItem ( RawItemHdrP riP )

Returns a pointer to the raw item's dialog item.

Parameters

[in] riP a pointer to the raw item header.

Returns: The raw item's dialog item.

Remarks: Required Library: mdlbltin.lib; Code that can use C data structures does not need this. This function is provided to support languages such as VBA that can not use complicated C data structures.

MSDialogP mdlDialog_statusAreaGet ( void )

Returns a pointer of the Dialog Box containing the current snap icon, active level, etc.

Since the command window style interface does not have a status area, this function can be used to determine the currently selected interface style.

Returns: A pointer to the MSDialog that contains the status area. In the command window style interface, this function returns NULL. In the status bar style interface, this function returns a pointer to the status bar.

See also: mdlDialog_commandWindowGet mdlDialog_keyinWindowGet mdlDialog_overallTitleBarGet mdlDialog_menuBarGetCmdWinP

Remarks: Required Library: mdlbltin.lib

void mdlDialog_toolSettingsAdjustWidthAndHeight ( )

Adjusts the width and height of the Tool Settings window after hiding or showing items in the Command Item List.

StatusInt mdlDialog_userPrefFileOpen	(	RscFileHandle *	userPrefHP,
		int	readWriteAccess
	)

Obtains a resource file handle corresponding to the active user preferences file for the current MicroStation session.

Other resource manager calls such as mdlResource_addByAlias and mdlResource_loadByAlias can be called using this resource file handle.

Remarks: If an application does store resources in the MicroStation user preferences file, it should follow two rules. First, it should always use positive resource IDs. Negative resource IDs are reserved for MicroStation. Second, the resources added by an application should always be qualified by an alias name equal to the application's task ID to keep its resources from being overwritten by user preference resources belonging to other applications.

Parameters

[out]	userPrefHP	points to a location to receive the resource file handle for the user preferences file.
[in]	readWriteAccess	is one of the valid file access modes defined in mdlResource_openFile.

Returns: SUCCESS if the open succeeds, or ERROR if an error occurs.

See also: mdlResource_openFile mdlResource_loadByAlias mdlResource_addByAlias

Remarks: Required Library: mdlbltin.lib

Functions

Detailed Description

Function Documentation