home login register your profile contact        
Affymetrix
Products Support Analysis Scientific Community Corporate Careers Shop Affymetrix Japan
Software Developer Network
File SDK Overview
File SDK Downloads
File SDK Object Hierarchy
IGDACEXPFile
IGDACDATFile
IGDACCELFile
IGDACCHPFile
IGDACCDFFile
IGDACProbe
IGDACProbeSet
IGDACProbePair
IGDACControlProbeSet
IGDACCustomSeqComposite
IGDACCustomSeqProbeSet
IGDACCustomSeqProbeGroup
IGDACCustomSeqProbeList
IGDACGenotypeProbeSet
IGDACGenotypeProbeGroup
IGDACGenotypeProbeList
IGdacFileChooserDlg
IGDACFilesMode
File SDK Definitions
File SDK Messages
File SDK Release Notes

IGDACEXPFile


OVERVIEW
The IGDACEXPFile interface provides read-only access to experiment (EXP) files. The EXP file contains experiment information as captured by the Microarray Suite software in file mode. LIMS and GCOS experiment attributes are not accessible from this interface.

COM ATTRIBUTES

AttributeType/Supported
Threading modelBoth
InterfaceDual
AggregationNo
ISupportErrorInfoYes
Connection PointsNo
Free Threading MarshalerNo

PROPERTIES

Name
ID

1

Description

The name of the EXP file without directory path.

TypeBSTR
Length64 characters including file extension.
AccessRead-Write
Remarks 

It accepts any valid short file name with no path specified (e.g. Hu6800.EXP).  If path is specified when setting the Name property, a COM error will be thrown.  However, the DataPath property must be set to identify the actual location of the experiment file.

Returns error if setting invalid file name characters: \/:;*?"<>|'`,{}[]
Returns error if file name is not with ".EXP" extension.

DataPath
ID

2

Description

The directory where the EXP files are stored.

TypeBSTR
AccessRead-Write
Remarks Returns error if setting invalid path characters: /;*?<>|'`,{}[]

LibPath
ID

3

Description

The directory where the the library files (CDF) are stored.

TypeBSTR
AccessRead-Write
Remarks

Returns error if setting invalid path characters: /;*?<>|'`,{}[]

FullPathName
ID

4

Description

The full path file name for the experiment file.   

TypeBSTR
AccessRead-only
RemarksThis property is set when setting the Name property and DataPath of this interface.

ChipType
ID

5

DescriptionThe probe array type associated with the experiment.  
TypeBSTR
AccessRead-only
Remarks

Read() must be called prior to use.  Returns an empty string if the experiment file has not been read.

Date
ID

6

DescriptionThe file creation timestamp.
TypeBSTR
FormatMMM DD YYYY HH:MM:SS AM/PM
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

ChipLot
ID

7

DescriptionThe probe array lot number.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

Operator
ID

8

DescriptionThe operator defined the in experiment
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

SampleType
ID

9

DescriptionThe sample type defined in the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

SampleDesc
ID

10

DescriptionThe sample description defined in the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

Project
ID

11

DescriptionThe sample project defined in the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.

Comments
ID

12

DescriptionThe comments defined in the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

Reagents
ID

13

DescriptionThe reagents defined in the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

ReagentsLot
ID

14

DescriptionThe reagent lot number defined in the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.

Protocol
ID

15

DescriptionThe fluidics protocol used in the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

Station
ID

16

DescriptionThe fluidics station number used to run the protocol.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

Module
ID

17

DescriptionThe fluidics module number used to run the protocol.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

HybridizeDate
ID

18

DescriptionThe date the fluidics protocol was run.
TypeBSTR
FormatMMM DD YYYY HH:MM:SS AM/PM
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

ScanPixelSize
ID

19

DescriptionThe pixel size, in microns, used when scanning the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

ScanFilter
ID

20

DescriptionThe filter value used when scanning the experiment.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

ScanDate
ID

21

DescriptionThe date of the scan.
TypeBSTR
FormatMMM DD YYYY HH:MM:SS AM/PM
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

ScannerID
ID

22

DescriptionThe ID of the scanner if set on the MAS instrument workstation.
TypeBSTR
AccessRead-only
RemarksRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

NumberOfScans
ID

23

DescriptionThe number of image scans.
Typelong
AccessRead-only
RemarksRead() must be called prior to use.  Returns 0 if the experiment file has not been read.

ScannerType
ID

24

DescriptionThe scanner type.
TypeBSTR
AccessRead-only
ReadRead() must be called prior to use.  Returns an empty string if the experiment file has not been read.

NumProtocolSteps
ID

25

DescriptionThe number of steps in the fluidics protocol.
Typelong
AccessRead-only
RemarksRead() must be called prior to use.  Returns 0 if the experiment file has not been read.

ServerName
ID

26

DescriptionThis value is not used by the SDK.
TypeBSTR
AccessRead-Write
RemarksThis value is not used by the SDK.

NTUserName
ID

27

DescriptionThis value is not used by the SDK.
TypeBSTR
AccessRead-Write
RemarksThis value is not used by the SDK.

 

METHODS

Exists
ID

28

DescriptionThis function returns a flag indicating if the EXP file exists within the specified data directory.  
PrototypeHRESULT Exists(BOOL *pbExists)
ParametersBOOL *pbExists - Flag indicating existence (output)
ReturnHRESULT - S_OK if successful, E_FAIL otherwise
RemarksThe Name and DataPath properties are required.

Read
ID

29

DescriptionReads the contents of the EXP file into memory.
PrototypeHRESULT Read( )
ParametersN/A
ReturnHRESULT - S_OK if successful, E_FAIL otherwise
RemarksThe Name and DataPath properties are required

GetProtocolStep
ID

30

DescriptionThis function returns one of the fluidics station protocol steps stored in the EXP file. The return string contains the name of the parameter and its value separated by a tab.
PrototypeHRESULT GetProtocolStep(long nIndex, BSTR *pStep)
Parameters

long nIndex - Protocol step index. It is 0-based and must be in between 0 and NumProtocolSteps (input)
BSTR *pStep - A pointer to the protocol step string. (output)

ReturnHRESULT - S_OK if successful, E_POINTER if ppsaSteps is NULL or E_FAIL otherwise
RemarksRead() must be called prior to use.

GetProtocolSteps
ID

31

DescriptionThis function returns one all the fluidics station protocol steps stored in the EXP file. Each string in the array contains the name of the parameter and its value separated by a tab.
PrototypeHRESULT GetProtocolSteps(SAFEARRAY(BSTR)* ppsaSteps)
Parameters

lSAFEARRAY(BSTR)* ppsaSteps - A pointer to a pointer of safe array of the protocol steps. (output)

ReturnHRESULT - S_OK if successful, E_FAIL otherwise
RemarksRead() must be called prior to use.

888-DNA-CHIP (888-362-2447) +44 (0) 1628 552550 feedback e-mail support terms of use privacy policy