Public Attributes | List of all members
FileOpenParams Struct Reference

Structure used by mdlDialog_fileOpenExt. More...

#include <filelist.h>

Public Attributes

RscFileHandle dialogRscH
 Resource file from which to load a user-specified Dialog Box. More...
 
RscId dialogId
 ID of a Dialog Box in the resource file specified by dialogRscH. More...
 
int openCreate
 Controls the attributes of the Dialog Box. More...
 
WCharCP suggestedFileNameP
 File name that will be suggested to the user when the Dialog Box is first opened. More...
 
WCharCP defaultFilterP
 The filter to use for determining which files to include in the file list. More...
 
WCharCP filterInfoStrP
 String which describes defaultFilterP, specify NULL for the default description. More...
 
WCharCP defaultDirP
 The directory where the selection process starts. More...
 
WCharCP dirCfgVarP
 The name of a MicroStation configuration variable which is used to populate the contents of the "Directory" menu in the Dialog Box. More...
 
WCharCP titleP
 The title of the Dialog Box. More...
 
RscId defFileId
 Identifies a resource in the user preference file specified by defFileRscH. More...
 
RscFileHandle defFileRscH
 User preference resource file opened by the calling application. More...
 
MdlDescdialogOwnerMD
 Unused, pass NULL. More...
 
WCharP defSeedFileNameP
 defSeedFileNameP, defSeedDirP, defSeedFilterP and defSeedFileId are identical to suggestedFileNameP, defaultDirP, defaultFilterP and defFileId except that these are used for the seed file Dialog Box. More...
 
WCharCP defSeedDirP
 see defSeedFileNameP More...
 
WCharCP defSeedFilterP
 see defSeedFileNameP More...
 
RscId defSeedFileId
 see defSeedFileNameP More...
 
UInt32 requiredRights
 Specifies the rights that the user must have to allow the application to process the file. More...
 
DgnFileSupplyRightsP reloadContext
 mdlDialog_fileOpenExt will set this to a load context that can be used for future access to the file via mdlWorkDgn_openFileWithRights. More...
 
RscId filterStringListId
 Id of String list containing file filters and descriptions. More...
 
RscFileHandle filterStringHandle
 
struct {
   UInt32   preIncludeCADFileOpenFilters:1
 
   UInt32   postIncludeCADFileOpenFilters:1
 
   UInt32   unused:30
 
filterFlags
 unused; should be set to zero More...
 
int winOpenReturnCode
 
int futureUse
 
WCharCP futureUseCharP [4]
 unused; should be set to zero More...
 
WCharCP workSetNameP
 WorkSet for which file and Directory history should be shown. More...
 
WCharCP workSpaceNameP
 WorkSpace for which file and Directory history should be shown. More...
 

Detailed Description

Structure used by mdlDialog_fileOpenExt.

Before use, the entire structure should be memset to 0, and then individual fields set as necessary.

Member Data Documentation

WCharCP defaultDirP

The directory where the selection process starts.

It can also be an environment variable, in which case the directory associated with the variable is used. Will be overriden if suggestedFileNameP contains path information. Specify NULL to use the current working directory.

Referenced by MSDocumentOpenDialogParams::GetDefaultDir(), and MSDocumentOpenDialogParams::SetDefaultDir().

WCharCP defaultFilterP

The filter to use for determining which files to include in the file list.

It is useful for limiting files displayed to a particular type. Simple wildcarding is allowed. An asterisk `*' matches any string and a question mark `?' matches any single character. Specify NULL to match all files (*.*).

Referenced by MSDocumentOpenDialogParams::GetDefaultFilter(), and MSDocumentOpenDialogParams::SetDefaultFilter().

RscId defFileId

Identifies a resource in the user preference file specified by defFileRscH.

This resource is used in two ways. First, it will be loaded just prior to the display of the Dialog Box to obtain the suggestedFileName and fileFilter used during the last execution of this Dialog Box (using the same defFileId). Second, if the user successfully chooses a file in the Dialog Box (indicated by clicking OK), the new filename and filter are saved back to the resource in the user preference file. For the complete list of defFileId values used by MicroStation dialogs, see deffiles.h

Referenced by MSDocumentOpenDialogParams::GetDefFileId(), and MSDocumentOpenDialogParams::SetDefFileId().

RscFileHandle defFileRscH

User preference resource file opened by the calling application.

This is where the default file information, as specified by defFileId, is loaded from and saved after the user makes a new file selection. Specify NULLRSC to use the MicroStation User Preferences file.

Referenced by MSDocumentOpenDialogParams::GetDefRscFileHandle(), and MSDocumentOpenDialogParams::SetDefRscFileHandle().

WCharCP defSeedDirP
RscId defSeedFileId
WCharP defSeedFileNameP

defSeedFileNameP, defSeedDirP, defSeedFilterP and defSeedFileId are identical to suggestedFileNameP, defaultDirP, defaultFilterP and defFileId except that these are used for the seed file Dialog Box.

The seed file Dialog Box can be invoked from the create Dialog Box and allows the user to specify which seed file to use in the creation of the design file. These fields are only used if FILELISTATTR_CREATEFROMSEED is specified by openCreate.

Referenced by MSDocumentOpenDialogParams::GetDefSeedFileName(), and MSDocumentOpenDialogParams::SetDefSeedFileName().

WCharCP defSeedFilterP
RscId dialogId

ID of a Dialog Box in the resource file specified by dialogRscH.

The first six items in the Dialog Box should match the corresponding items in the standard file open/create Dialog Box. Specify 0 to use the default Dialog Box.

Referenced by MSDocumentOpenDialogParams::GetDialogId(), and MSDocumentOpenDialogParams::SetDialogId().

MdlDesc* dialogOwnerMD
RscFileHandle dialogRscH

Resource file from which to load a user-specified Dialog Box.

Specify NULLRSC to use the default resource file.

Referenced by MSDocumentOpenDialogParams::GetRscFileHandle(), and MSDocumentOpenDialogParams::SetRscFileHandle().

WCharCP dirCfgVarP

The name of a MicroStation configuration variable which is used to populate the contents of the "Directory" menu in the Dialog Box.

Referenced by MSDocumentOpenDialogParams::GetDirCfgVar(), and MSDocumentOpenDialogParams::SetDirCfgVar().

struct { ... } filterFlags
WCharCP filterInfoStrP

String which describes defaultFilterP, specify NULL for the default description.

For multiple filters, use a comma-seperated string. For example, to get both DGN and RSC files, you might use: "*.dgn,MicroStation Design Files [*.dgn],*.rsc,MicroStation Resource Files [*.rsc]"

Referenced by MSDocumentOpenDialogParams::GetFilterInfoString(), and MSDocumentOpenDialogParams::SetFilterInfoString().

RscFileHandle filterStringHandle
RscId filterStringListId

Id of String list containing file filters and descriptions.

Referenced by MSDocumentOpenDialogParams::GetFilterStringListId(), and MSDocumentOpenDialogParams::SetFilterStringListId().

int futureUse
WCharCP futureUseCharP[4]

unused; should be set to zero

int openCreate

Controls the attributes of the Dialog Box.

Specify by bitwise or'ing the FILELISTATTR_ constants defined in filelist.h. Commonly used attribute sets can be used by directly specifying:

FILELISTATTR_OPEN
FILELISTATTR_CREATE
FILELISTATTR_CREATEFROMSEED
FILELISTATTR_OPENCREATE
FILELISTATTR_DEFAULT

Referenced by MSDocumentOpenDialogParams::GetOpenCreate(), and MSDocumentOpenDialogParams::SetOpenCreate().

UInt32 postIncludeCADFileOpenFilters
UInt32 preIncludeCADFileOpenFilters
DgnFileSupplyRightsP reloadContext

mdlDialog_fileOpenExt will set this to a load context that can be used for future access to the file via mdlWorkDgn_openFileWithRights.

Passing a loadContext to that function will avoid prompting the user for the same password multiple times.

UInt32 requiredRights

Specifies the rights that the user must have to allow the application to process the file.

This allows the dialog to check if the user has sufficient rights before returning control back to the application. Valid values are:

DgnPlatform::DGNFILE_RIGHT_Any
DgnPlatform::DGNFILE_RIGHT_Print
DgnPlatform::DGNFILE_RIGHT_Export
DgnPlatform::DGNFILE_RIGHT_Edit
DgnPlatform::DGNFILE_RIGHT_Unlimited

Referenced by MSDocumentOpenDialogParams::GetRequiredRights(), and MSDocumentOpenDialogParams::SetRequiredRights().

WCharCP suggestedFileNameP

File name that will be suggested to the user when the Dialog Box is first opened.

This value is overridden if the defFileId parameter is provided and resource information for this parameter exists in the file specified by defFileRscH.

Referenced by MSDocumentOpenDialogParams::GetSuggestedFileName(), and MSDocumentOpenDialogParams::SetSuggestedFileName().

WCharCP titleP
UInt32 unused
int winOpenReturnCode
WCharCP workSetNameP

WorkSet for which file and Directory history should be shown.

Referenced by MSDocumentOpenDialogParams::GetWorkSetName(), and MSDocumentOpenDialogParams::SetWorkSetName().

WCharCP workSpaceNameP

WorkSpace for which file and Directory history should be shown.

Referenced by MSDocumentOpenDialogParams::GetWorkSpaceName(), and MSDocumentOpenDialogParams::SetWorkSpaceName().


The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.