home login register your profile contact        
Affymetrix
Products Support Analysis Scientific Community Corporate Careers Shop Affymetrix Japan
Software Developer Network
NetAffx SDK Overview
NetAffx SDK Downloads
NetAffx SDK Annotation Object
NetAffx SDK Annotation Listing Object
NetAffx SDK Annotation Listing URL
NetAffx SDK Release Notes

NetAffx SDK Annotation Listing Object


OVERVIEW

The IGDACNetAffxAnnotationListing object is used to retrieve the list of annotations and to retrieve the annotation files from the NetAffx web site.

PROPERTIES

ConnectionIdentifier
DescriptionAn identifier used to connect to NetAffx.
TypeBSTR
AccessWrite-only
Remarks This must be set prior to retrieving annotations from NetAffx.

UserName
DescriptionThe user name to use to connect to NetAffx.
TypeBSTR
AccessWrite-only
Remarks This must be set prior to retrieving annotations from NetAffx.

Password
DescriptionThe users password to use to connect to NetAffx.
TypeBSTR
AccessWrite-only
Remarks This must be set prior to retrieving annotations from NetAffx.

DataDirectory
DescriptionThe directory where the annotations are to be downloaded to.
TypeBSTR
AccessWrite-only
Remarks This must be set prior to retrieving annotations from NetAffx.

NumAnnotations
DescriptionThe number of annotations available from NetAffx.
Typelong
AccessRead-only
Remarks This value is set after the call to RetrieveAnnotationList().

METHODS

RetrieveAnnotationList
DescriptionRetrieves the list of available annotations from NetAffx.
PrototypeHRESULT RetrieveAnnotationList([out, retval] BOOL *pStatus);
ParameterspStatus (out) - The return value.
Return TRUE if successfully obtained the list of annotations, FALSE otherwise.
RemarksNone

GetAnnotation
DescriptionReturns an Annotation object for the given index.
PrototypeHRESULT GetAnnotation([in] long index, [in] IGDACNetAffxAnnotation *pAnnotation);
Parameters

index (in) - The index to the desired annotation file.
pAnnotation (in/out) - The information about the requested annotation.

Return HRESULT - S_OK if the method succeeded.
Remarks

The RetrieveAnnotationList() function must be called prior to obtaining the information.

The index must be between 0 and the number of annotations (NumAnnotations).

RetrieveAnnotationFile
DescriptionReturns the annotation file for the given index.
PrototypeHRESULT RetrieveAnnotationFile([in] long index, [out, retval] NETAFFX_DOWNLOAD_STATUS_TYPE *pStatus);
Parameters

index (in) - The index to the desired annotation file.
pStatus (out) - The return value.

Return TRUE if successfully obtained the annotation file, FALSE otherwise.
Remarks

The RetrieveAnnotationList() function must be called prior to obtaining the information.

The index must be between 0 and the number of annotations (NumAnnotations).

The name and location of the annotation file retrieved is available in the Annotation object using the GetAnnotation() function.

The return value (pStatus) will either be DOWNLOAD_FILE_FAILED indicating a failure to download the file, DOWNLOAD_FILE_SUCCESS indicating that the file was successfully downloaded or DOWNLOAD_FILE_NOT_UPDATED indicating that the file is already cached in the data directory and an update was not required.

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