ArcObjects Library Reference (Carto)  

IImageServer.ExportImage Method

Exports into a well-known image for a given image description.

[Visual Basic .NET]
Public Function ExportImage ( _
    ByVal pImageDescription As IGeoImageDescription, _
    ByVal pImageType As IImageType _
) As IImageResult
[C#]
public IImageResult ExportImage (
    IGeoImageDescription pImageDescription,
    IImageType pImageType
);
[C++]
HRESULT ExportImage(
  IGeoImageDescription* pImageDescription,
  IImageType* pImageType,
  IImageResult** ppImage
);
[C++]

Parameters

pImageDescription [in]

  pImageDescription is a parameter of type IGeoImageDescription

pImageType [in]

  pImageType is a parameter of type IImageType

ppImage [out, retval]

  ppImage is a parameter of type IImageResult

Product Availability

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

Description

Exports image data from the image server using the GeoImageDescription and ImagType.

Remarks

The supported formats, defined using the ImageType parameter, include JPEG, PNG, BMP, and TIFF. The JPEG format is the same as the JPEG compressed image returned from the GetImage method. Image content can be returned as a URL or as a MIME data stream.

If the size of the image in terms of number of columns and rows exceeds the limit defined in the image service configuration, this method will return an error.

If the pixel type defined in ImageDescription is different from the pixel type of the image service, the pixel values will be converted according to the specified pixel type if possible. Otherwise, an error will be returned at 9.3.

New at 10.0, if the image service pixel type cannot be converted to the requested pixel type, a default raster renderer will be applied. A proper default renderer is created using the same rule as when a raster dataset of the same properties, e.g. number of band, pixel type, and etc is added to map.

 

 

See Also

IImageServer Interface | IGeoImageDescription Interface