Search

Variable List for MicroStation/J

Support

<< Return to Index
Subject: Variable List
Product: MicroStation/J
Operating System: Windows® 95, Windows 98, Windows NT®, Windows 2000
Document Number: 8168
This technical document lists many of the MicroStation/J variables.

System Environment Category

MS

The MicroStation root installation directory. Used by MDL example make files.

MS_CONFIG

Main MicroStation configuration file, sets up all configuration variables.

MS_EDG

EDG directories, not used by MicroStation itself, only EDG.

RSC_COMP

Specifies text to be inserted at the beginning of the command line by the resource compiler. This is generally used to specify where to search for include files.

MDL_COMP

Specifies text to be inserted at the beginning of the command line by the MDL compiler and rsctype. This is generally used to specify where to search for include files.

BMAKE_OPT

Command line options for BMAKE. This is generally used to specify where to search for bmake include (.mki) files.

MS_DEBUGMDLHEAP

Set to the base name of an MDL application (or ALL). If set use extended malloc for debugging. This must be set as a system environment variable

Configuration Category

MSDIR

The MicroStation root installation directory.

MSLOCAL

Specifies the base directory path for where the required writeable portions (i.e. local for a network install) of MicroStation are installed.

_USTN_DEFUSERINTNAME

Sets the default interface, if the _USTN_USERINTNAME variable is not defined. The following variables are based on _USTN_DEFUSERINTNAME: _USTN_USERINTNAME, _USTN_UIPATH

_USTN_USERINTNAME

Subdirectory under "_USTN_USERINT" that actually contains the user interface resource modification files.

_USTN_USERINTROOT

Defines the user interface root directory.

_USTN_USERINT

User interface data directory.

_USTN_PROJECTNAME

MicroStation base project name.

_USTN_USERCFG

MicroStation user configuration file name.

_USTN_USERNAME

MicroStation base user name.

_USTN_USERDESCR

Description of current user configuration.

_USTN_DEFAULTUSER_CFG_FILE

Base name of the configuration file that holds the default user name.

_USTN_USER

Directory containing MicroStation user configuration files.

_USTN_PROJECTDATA

Defines the workspaces project data directory.

_USTN_PROJECTSROOT

Defines the root directory for the project sub-directories. By default, set to $(_USTN_WORKSPACEROOT)projects\. The following variable is based on _USTN_PROJECTSROOT: _USTN_PROJECT

_USTN_PROJECT

Directory containing MicroStation project configuration files.

_USTN_DATABASE

Directory containing MicroStation database configuration files.

_USTN_SITE

Directory containing MicroStation site configuration files.

_USTN_APPL

Directory containing MicroStation application configuration files.

_USTN_WORKSPACEROOT

Defines the root workspace. By default, set to Bentley\Workspace\. The following variables are based on _USTN_WORKSPACEROOT: _USTN_SYSTEMROOT, _USTN_SITE, _USTN_PROJECTSROOT, _USTN_USER, _USTN_USERINTROOT

_USTN_SYSTEMROOT

Defines the default system data files used by MicroStation. By default, set to $(_USTN_WORKSPACEROOT)standards\; $(_USTN_WORSPACEROOT)system\

_USTN_SYSTEM

Directory containing MicroStation system configuration files.

_USTN_DATABASECFG

MicroStation database configuration file name.

_USTN_DATABASENAME

Base name of current database configuration file.

_VERSIONXX

Indicates that the current product's version number is X.X

_PLATFORMNAME

Short name of this platform. Useful for building platform-specific sub-directories.

_WORKDIR

Directory where MicroStation was started.

_DGNDIR

Directory containing the current Design File

_ROOTDIR

Location (directory) of the MicroStation executable.

_USTN_OUT

Base directory for MicroStation output files.

_USTN_CHARTRAN

Directory containing character translation tables.

_USTN_NEWDGNFILE

List of MDL applications to be reloaded each time a new design file is opened, except when it is the first design file.

_USTN_FIRSTDGNFILE

List of MDL applications that are loaded on startup after the user selects an initial design file.

_USTN_REQUIREDAPPS

List of MDL applications that are required to be loaded while MicroStation is running.

_USTN_DISPLAYALLCFGVARS

If set, all configuration variables (including those of the format _USTN_xxx) will be displayed.

_MICROSTATION

Set if product is MicroStation.

_WINNT

Set if operating system is Windows NT.

_USTN_HOMEROOT

Location for Bentley product-specific data that is unique to a computer or workstation. (MicroStation/J v7.1 only)

_USTN_HOMEPREFS

Location of home preferences. (MicroStation/J v7.1 only)

_USTN_BENTLEYROOT

Defines the root directory for Bentley product suite. By default, set to \Bentley\. The following variables are based on _USTN_BENTLEYROOT: _USTN_WORKSPACEROOT, _USTN_LICENSING.

_USTN_UISTANDARDS

Defines the directory for the "Corporate Standard" modification files (for example, ustn.s01). Note: This variable is not defined and is not necessary, but is placed within msconfig.cfg to act as a guide for users who want to create a corporate standard. The variable must be defined before using it.

ALL lists only

MS_CACH

Optional cache ID string for MicroCSL.

_USTN_CUSTOMIZEBASEID

Specifies a base number at which Customize will begin generating ids for user-created resources. After this value has been set, Customize will not create any resources with a resource id lower than this value

_USTN_RMGR_MAXFILEPTRS

Specifies the maximum number of operating system file pointers that the Resource Manager will use internally to manipulate all its logical resource file handles. In version 5, this value was fixed at 6. Starting in version 5.5, the new default is 12 but can be overridden by this configuration variable.

MS_BASICEXT_LOAD

List of MDL applications that implement extensions to the BASIC language.

MS_DATA

Directory for data files created/used by MicroStation.

MS_OLDUSERLICENSE

File containing old user license information. Necessary for an upgrade installation.

MS_USERLICENSE

File containing user license information.

MS_CMDWINDRSC

MicroStation command window resource file. If not defined, use default.

MS_GUIHAND

Identifies auxiliary handlers.

MS_DYNAWEB_HELPSERVER

Specifies the server where the DynaWeb help files are located.

MS_HELPPATH

MicroStation help path.

HISTORY_MAX_MINOR_VERSIONS

The number of minor versions for the Limit History command to preserve in the history file

MS_UNDO

If set, overrides the user preference undo buffer size. The value should be the number of bytes that should be allocated to the undo buffer.

MS_RIGHTLOGICKB

If set equal to 1, support typing from right to left. Used for foreign language support.

WRK_DD_IGDS

Directory for IGDS user commands.

MS_DEMOONLY

If set, run MicroStation in demo-only mode.

MS_INITAPPS

List of all initial start up MDL Applications.

MS_EXE

The directory containing the MicroStation executable.

MS_RSRC

Main MicroStation resource, typically set to ustation.rsc.

MS_DGNOUT

Directory containing design files created from "on the fly" translations.

MS_TUT_UCMS

Directory containing user commands that drive tutorials.

_USTN_ALTCHARTRAN

Alternate character translation table.

MS_DEFCHARTRAN

Default character translation table.

MS_CODESET

MDL application for handling multi-byte character sets.

CLASSPATH

Search path used to find Java/JMDL classes.

MS_OPENDESIGNFILEFILTER

If this variable is set, then MicroStation Manager and the Open Design File dialog will use the value as the initial filter. An example value is "*.*".

MS_SELECTSERVICESHOME

URL location for SELECTservices (http://selectservices.bentley.com/). (MicroStation/J v7.1 only)

MS_SPELLINGUSERDICTIONARY

Location of the user dictionary, include path and filename. (MicroStation/J v7.1 only)

Primary Search Path Category

MS_DEF

Search path for design files.

MS_RFDIR

Search path(s) for reference files.

MS_MDLAPPS

Search path for MDL applications that are displayed in the MDL dialog box.

MS_MDL

Search path for MDL applications or external programs loaded by MDL applications.

MS_MACRO

Search path for macros.

MS_RSRCPATH

Search path for resource files loaded by MDL applications.

MS_LIBRARY_PATH

Search path for dynamic link libraries.

Plotting Category

MS_BATCHPLT_SPECS

Name of the file containing batch plotting specifications.

MS_PLTFILES

Directory for plotting output files.

MS_PLOTINI

Search path(s) for saved plot configuration files.

MS_PLTR

Name of the plotter driver file that describes plotter features.

MS_PENTABLE

Search path(s) for pen tables.

Cell Category

MS_CELL

Search path(s) for cell libraries.

MS_CELLLIST

List of cell library files to be searched for cells if not found in the current library. May contain wildcards.

MS_CELLSELECTORDIR

Directory for Cell Selector button configuration (.csf) files.

MS_CELLSELECTOR

Default Cell Selector button configuration file.

MS_CELLOUT

Defines the directory for creating new cell libraries. By default, set to the first directory defined by MS_CELL

MS_MENU

Cell library name for finding menu cells.

MS_TUTLIB

Cell library file containing tutorial cells.

User Command Category

MS_UCM

Search path(s) for user commands.

MS_INIT

Name of a user command to be executed at startup.

MS_EXIT

Name of a user command to be executed at exit.

MS_NEWFILE

Name of a user command to be executed when a new design file is opened.

MS_APP

Search path(s) of applications started from 'TSK' statement in user commands.

Seed Category

MS_SEEDFILES

Search path(s) for all seed files.

MS_DESIGNSEED

Default seed file for creating design files.

MS_CELLSEED

Default seed file for creating cell libraries.

MS_TRANSEED

Default seed file used for DWG, CGM, and IGES translations.

MS_SHEETSEED

Seed file used when creating drawing sheets.

MS_USERPREFSEED

Name of seed file used to create user preference resource file.

Temp/Backup Category

MS_BACKUP

Default directory for backup files.

MS_TMP

Directory containing temporary files that are created and deleted by MicroStation.

MS_SCR

Directory for scratch files created by MicroStation

Colors Category

MS_DEFCTBL

Default color table if the design file has none.

MS_RMENCTBL

Default menu colors (dialogs, dialog borders, etc.) for the right screen. File specification pointing to a color table (.tbl) file

MS_LMENCTBL

Default menu colors (dialogs, dialog borders, etc.) for the left screen. File specification pointing to a color table (.tbl) file

Symbology Category

MS_SYMBRSRC

A list of symbology resource files. Files are opened in the order they appear in the list. The last one in the list has the highest priority. If undefined, MicroStation looks in the current resource path for a file called "mssymb.rsc".

System Operation Category

MS_ENHANCEDPRECISION

If set to 1, enhanced precision is enabled. If set to 0, it is disabled. Must re-open design file (rd=) for setting change to take effect.

MS_FKEYMNU

Function key menu file.

MS_ACCUDRAWKEYS

Text file listing AccuDraw shortcut keys.

MS_GRAPHICSACCELERATOR

Set to define the graphics accelerator application. Set to "qvisgl" if OpenGL technology is available on the current operating system, "quickvis" otherwise.

MS_BACKUPBEFORECOMPRESS

If set to 1, backup the current design file or cell library to MS_TMP directory before compressing. If set to 0, disable creation of backups, which can conserve disk space.

MS_RASTERSCAN

If set to 1, raster reference scanning enabled. If set to 0, disable scan.

MS_SAVEMENU

File where MicroStation stores information about attached menus. In previous versions this file name was hard-coded to mgds.men

MS_APPMEN

Location of application and sidebar menus.

MS_WORKSPACEOPTS

If set to 0 (default), the workspace options are displayed on the MicroStation Manager dialog box. If set to 1, the workspace options are displayed but disabled. If set to 2, the workspace options are hidden and the dialog box is resized.

MS_USECOMMANDWINDOW

If set to 0, MicroStation will be locked in the status bar interface. If set to 1, MicroStation will be locked in the command window interface. If not set (default), user can choose interface style from MicroStation Manager.

MS_FILEHISTORY

If set equal to 1, save the last four files and directories for each file type. If set equal to 0, no file histories will be maintained.

MS_SYSTEM

If set equal to 1, allow the user to escape to the operating system. If it is undefined or set to 0, the user cannot escape.

MS_READONLY

If set, design file will be read only.

MS_NOEOF_MSGFILE

If set, display the contents of this file when a no end-of-file error is encountered. Setting this variable also prevents the file from being opened.

MS_DISALLOWFULLREFPATH

When set to 1, the ability to save a Reference File with its full path is disallowed. This variable affects the ' Save Full Path ' toggle for both the Attach Settings and Attach Reference File dialog boxes for Reference Files. This also affects the ' Store Full Path When Attached ' toggle under the category Reference File for the User Preference dialog. Also the Drawing Composition dialog's 'Save Full Path' toggle is affected.

Rendering/Image Category

MS_MATERIAL

Search path(s) for material palettes.

MS_PATTERN

Search path(s) for pattern maps.

MS_BUMP

Search path(s) for bump maps.

MS_IMAGE

Search path(s) for images.

MS_IMAGEOUT

Directory where created images will be stored.

MS_SHADOWMAP

Directory where shadow maps will be read from and written to.

MS_LIGHTING

Directory where IES lighting data files will be read from.

MS_RENDERLOG

File name and directory for recording rendering statistics.

Database Category

MS_DBASE

Search path(s) for database files.

MS_SERVER

MDL application to load the database server.

MS_DBEXT

The database server application.

MS_LINKTYPE

User data linkage types recognized by the server. First one listed is the linkage type that will be created. Possible values are "ODBC", "XBASE", "DMRS", "IX", "ORACLE", and "RIS".

MS_DBMODE

File sharing flag for Xbase, either "shared" or nonshared, DOS only.

MS_DB_ODBC_DESCRIBE_DB

This variable, when set to view, will allow users to see their tables via VSQL if they have views. The user must include the table option in order to see standard tables. Link is used for Microsoft Access linked tables. Variables must be separated by commas or semicolons, for example MS_DB_ODBC_DESCRIBE_DB=view;table.

DBFORM_GEOLOCATE

If set to 1, the Visual SQL Query Builder Locate command functions similarly to the MicroStation GeoGraphics Locate command. This requires a mapid column in the database table and a maps table containing the design file names. See the example database in \bentley\program\microstation\database\odbc\examples\access\gis.mdb.

DBFORM_NO_FEATURE

If set to 1, you will see a feature's Feature linkage(s) in VSQL.

MS_DBDIALOGRSC

Set to the directory that will store database form files (*.rsc).

VSQL_OUTPUT_BROWSER

Defines the default output of the Visual SQL Query Builder. 0 = Forms, 1 = Browser

MS_DBODBCDATEFORMAT

Defines how VSQL formats the date. By default it is set to %m/%d/%Y to display a 4-digit year.

MS_ODBCPARAMS

Usage: MS_ODBCPARAMS=DSN=datasource;uid=username;pwd=password This will let the user autoconnect to the database using ODBC. DSN is the datasource name created in ODBC. UID/PWD are the user and password for the database (if any).

The above variable can also be used for making a connection using a FileDSN. This is an ASCII file that describes the database that should be used. The syntax is MS_ODBCPARAMS=FILEDSN=<full path to file DSN>. For example, MS_ODBCPARAMS = FILEDSN=j:/temp/odbcfiledsn.dsn. The drive j can be local or shared.

MS_ORACLELONGBYTEMAX

When given a value will increase long byte value in MicroStation. The default value in MicroStation is 1024. Oracle may return a value up to 4000 characters. This variable should be set to match the size of the Oracle value.

MS_BASICDBFORM

Points to a macro using Microsoft Access 2.0/7.0 Forms with Windows MicroStation. For details, see Workspace/system/macros/dbform.txt

MS_NOMSFORMSTABLE

If set to 1, no msforms or msf tables will be created in the database. These tables are only used if Oracle Forms are used. This variable may also be set as an Operating System variable, rather than in each workspace. This is configured through the System dialog in the Control Panel. Go to the Environment tab, User variables and set MS_NOMSFORMSTABLE = 1.

MS_ORACLE_HOME

Used to define the path to the Oracle client when the client machine has multiple Oracle clients installed. Enables MicroStation to connect quickly to the desired Oracle client by specifying the path explicitly. Use the path specified in the registry under ALL_HOMES as the path in this variable.

Miscellaneous Resources Category

MS_HTMLDGNDIR

Directory containing template design files used by the HTML Author to generate cell images for HTML documents.

MS_SETTINGS

Current settings resource file.

MS_SETTINGSOUTDIR

Defines the directory in which new Settings Manager files are created.

MS_SETTINGSDIR

Directory containing settings resource files.

MS_LEVELNAMES

Directory containing level structure data files.

MS_GLOSSARY

List of files for glossary to open to build list of terms

MDL Development Category

MS_RDE_SYSINC

Specifies text to be inserted at the beginning of the command line by the resource compiler DLM. This is generally used to specify where to search for include files.

MS_DBGSOURCE

Location of source code for MDL applications. Used by MDL debugger.

MS_MDLTRACE

If set to 1, additional debugging print statements will be provided when debugging MDL applications.

MS_ASSERT_MESSAGE

The format of assertion failure messages. The default is "Assertion Failure %s: %s(%d)"

MS_ASSERT_HANDLING

0: display error message, 1: log error message, 2: stop in debugger. The default is 0.

MS_DEBUGFAULT

If set to 1, automatically invoke the debugger when a fault is detected while an MDL application is active. This works regardless of whether or not the application's debug information was previously loaded.

MS_DEBUG

If set to an integer with bit 1 on, do not time out

MS_TRAP

Exception handling flag. Set to "NONE", "MDL", or ALL; Default = "ALL"

Chart Category

MS_GALLERYLIB

Cell library used by the chart application.

MS_GALLERYCELL

Default gallery cell to connect to.

DGNAPPS Category

MS_DGNAPPS

List of all design file MDL Applications.

Command Table Load Category

MS_CMDTABLE_LOAD

List of MDL Applications that will have their key-in tables auto-loaded.

CLASSPATH

Defines the search path used to find Java/MDL classes.

DWG-Translation Category

MS_DWGWIZRD

Configuration variable to enhance DWG Wizard.

MS_DWGIN

Input directory for DWG translations.

MS_DWGOUT

Output directory for DWG translations.

MS_DWGLOG

Output directory for DWG log files.

MS_DWGTABLES

Directory containing the DWG translation tables.

MS_DWGINSET

Settings file for the DWGIN application.

MS_DWGOUTSET

Settings file for the DWGOUT application.

MS_DWGCODEPAGE

Code page to be set in DWG/DXF file , ansi_1250

MS_DWGBASIC

BASIC program that controls DWG translations. Setting MS_DWGBASIC to a specific file can force DWG applications to always use one file and ignore previously used ones. If a full path is not given the file is assumed to be on the directory pointed to by MS_DWGDATA. (MicroStation/J v7.1 only)

MS_DWGDATA

Local directory to store DWG data files such as default DWG BASIC and GUI resources. (MicroStation/J v7.1 only)

CGM-Translation Category

MS_CGMIN

Input directory for CGM translations.

MS_CGMOUT

Output directory for CGM translations.

MS_CGMLOG

Output directory for CGM log files.

MS_CGMTABLES

Directory containing the CGM translation tables.

MS_CGMINSET

Settings file for the CGMIN application.

MS_CGMOUTSET

Settings file for the CGMOUT application.

IGES-Translation Category

MS_IGESIN

Input directory for IGES translations.

MS_IGESOUT

Output directory for IGES translations.

MS_IGESLOG

Output directory for IGES log files.

MS_IGESINSET

Settings file for the IGESIN application.

MS_IGESOUTSET

Settings file for the IGESOUT application.

Workspace Category

_USTN_PROJECTCFG

Name of project configuration file.

_USTN_PROJECTDESCR

Description of current project configuration.

MS_USERPREF

Name of user preference resource file.

_USTN_UIPATH

Search path for user interface modification resources.

Tags Category

MS_TAGOUTPUT

Defines the directory in which tag report templates are saved.

MS_TAGREPORTS

Output directory for tag data manager reports.

MS_TAGTEMPLATES

Directory containing tag data manager report templates

MS_TAGCOPYTOMASTER

Set to 1 to allow tags to be copied from a reference file to the master file along with the base objects they are associated to. (MicroStation/J v7.1 only)

MS_TAGTRANSFORMWITHBASEELEMENT

Set to 1 to allow tags to be manipulated/transformed with the base objects they are associated to. For instance, with this configuration variable enabled, rotating the base element by 45 degrees will also rotate any Tag Data by 45 degrees. (MicroStation/J v7.1 only)

GRD-Translation Category

MS_GRDIN

Input directory for GRD translations.

MS_GRDOUT

Output directory for GRD translations.

MS_GRDLOG

Output directory for GRD log files.

MS_GRDINSET

Settings file for the GRDIN application.

MS_GRDOUTSET

Settings file for the GRDOUT application.

Miscellaneous Category

MS_ARCHIVE

Search path(s) for Archive Files.

MS_ARCHIVECLASS

Search path(s) for Archive Class Files.

MS_KEYPAIRLIST

Digital Signature KeyPair file list.

USER

The user name stored in the file locking semaphore file. Only used when semaphore file locking is turned on - by a user preference.

NODE

The node name stored in the file locking semaphore file. Only used when semaphore file locking is turned on - by a user preference

OLE Server Category

MS_OLESERVE_EMBED_REFFILES

If set - Reference files will be embedded along with the main dgn file.

Engineering Links Category

MS_WEBLIB_HISTORY

Specifies the history file for the Weblib shared library

MS_BOOKMARKS_IMAGE

Specifies the bookmark file for remote images.

MS_BOOKMARKS_RSC

Specifies the bookmark file for remote resource files.

MS_BOOKMARKS_ARCHIVE

Specifies the bookmark file for remote archives.

MS_BOOKMARKS_CELL

Specifies the bookmark file for remote cell libraries.

MS_BOOKMARKS_DGN

Specifies the bookmark file for remote design files

MS_REFAGENTDATA

Specifies a file containing URL information for the Reference File Agent

MS_WEBKIOSKMODE

Set to 1 for Kiosk mode.

MS_WEBTYPESFILE

Specifies a file containing special handling instructions for various file types.

MS_WEBFILES_DIR

Specifies the directory in which copies of remote files are stored.

MS_WEBDOWNLOADDIR

Sets the directory in which WWW downloads are stored.

MS_USEEXTERNALBROWSER

Set to Netscape or IExplore in order to use an external browser.

How useful was this page?
less
  more
Suggest new content or let us know how we can improve this content (optional):

<< E-mail this page