This document is archived and information here might be outdated.  Recommended version.

IImageServer3.Download Method (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > II > IImageServer3 Interface > IImageServer3.Download Method
ArcGIS Developer Help

IImageServer3.Download Method

Clips images to a given geometry, and returns a list of downloadable files for a given set of catalog item IDs.

[Visual Basic .NET]
Public Function Download ( _
    ByVal pFIDs As IFIDSet, _
    ByVal pGeometry As IGeometry, _
    ByVal Format As String _
) As IImageServerDownloadResults
public IImageServerDownloadResults Download (
    IFIDSet pFIDs,
    IGeometry pGeometry,
    string Format
HRESULT Download(
  IFIDSet* pFIDs,
  IGeometry* pGeometry,
  BSTR Format
pFIDs [in]

pFIDs is a parameter of type IFIDSet* pGeometry [in]
pGeometry is a parameter of type IGeometry* Format [in]
Format is a parameter of type BSTR

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


The Download method return an ImageServerDownloadResults which contains multiple ImageServerDownloadResult objects, and each one of them contain a downloadable file and its size in bytes.

The number of items that can be downloaded is defined in the image service
configuration. One item might be corresponding to multiple files. For example a raster of a pan-sharpened image service consists of a single band raster dataset and a multiple band raster dataset, where each dataset might consist of multiple files such as an image file, a world file, and a pyramid file.The returned downloadable files can be URLs (e.g. http:// or ftp://) that are directly downloadable from a remote server. They can also be files that are known only to the image service. In this case, GetFile() should be used to prepare the file for download and get a public URL.

Downloading formats of folder structure, for example ESRI GRID, is not supported. It will be converted to tiff upon downloading.

New at 10.1, user can convert source rasters to other supported formats by �:Conversion� to the format string (for example: �JP2:Conversion�).


See Also

IImageServer3 Interface