Affymetrix - GDAC File Chooser Definition


		IGdacFileChooserDlg

OVERVIEW

The IGdacFileChooserDlg interface provides the functionality to allow a user to list, filter and select data files managed by Affymetrix software (MAS, LIMS, GCOS).

PROPERTIES

FileType

ID 3

Description The type of file to display in the dialog as the default. This value is set to the type of file selected after the ShowDialog method is invoked.

Type DBFD_FILE_TYPE

Access Read-write

Remarks The default is to show all file types.

Title

ID 4

Description The title of the file open dialog.

Type BSTR

Access Write-only

Remarks Set this value to change the title of the file open dialog.

AvailableFileTypes

ID 5

Description This value is used to define the list of file types to display. This is a bitwise combination of DBFD_FILE_TYPE values.

Type long

Access Write-only

Remarks The default value is to show all available file types.

MultiSelect

ID 6

Description A flag indicating whether the file open dialog should allow single or multiple file selection.

Type BOOL

Access Write-only

Remarks The default value is FALSE - single selection.

ServerName

ID 7

Description The name of the GCOS client or server or LIMS server or blank if the target system is MAS in file mode.

Type BSTR

Access Read-write

Remarks This value must be set prior to invoking the ShowDialog method.

DataPath

ID 8

Description The path name where the data files are stored.

Type BSTR

Access Read-write

Remarks
This value is initialized by the software and only needs to be set if the target Affymetrix system is MAS 5 in file mode. This value does not need to be set for the GCOS or LIMS systems.
If the user changes directories in the file open dialog, this value will be modified to be the directory where the data files are selected.
When settings this value for MAS 5 file mode, first set the ServerName property to an empty string then set this property.

LibraryPath

ID 9

Description The path name where the library files are stored.

Type BSTR

Access Read-write

Remarks
This value is initialized by the software and only needs to be set if the target Affymetrix system is MAS 5 in file mode. This value does not need to be set for the GCOS or LIMS systems.
When settings this value for MAS 5 file mode, first set the ServerName property to an empty string then set this property.

METHODS

ShowDialog

ID 1

Description This function returns a probe list object at the specified index.

Prototype HRESULT ShowDialog([in] unsigned long hParentWnd, [out] int* nResult)

Parameters
hParentWnd - A handle to the parent window.
nResult - A value indicating if the OK or CANCEL button was selected. The values are:
-1 - Indicates an error condition.
1 - The OK button was selected.
2 - The CANCEL button was selected.

Return
S_OK if the function succeeded.
E_POINTER if the nResult pointer is NULL.

Remarks
The nResult value and the return value should be checked to verify that the user selected a file, click OK and that the function succeeded.

GetSelectedFiles

ID 2

Description This method returns the list of selected files from the ShowDialog method.

Prototype HRESULT GetSelectedFiles([out] SAFEARRAY(BSTR)* ppsa)

Parameters ppsa - An array of files selected from the ShowDialog method. This file names will not contain the path where they reside. The path is available from the DataPath property.

Return HRESULT - S_OK if successful or E_FAIL otherwise.

Remarks
This method should only be called after a successful call to the ShowDialog method and the user clicked the OK button.