Share via

MapOptions.ReturnType Property

  • Article

Identifies whether the RenderServiceSoap.GetMap method should return a map image or a standard or secure URL to a cached map image. MapReturnType enumeration. Optional. Default is ReturnImage.

Public Dim ReturnType As [Namespace].MapReturnType
    Member of [Namespace].MapOptions
[C#]
public [Namespace].MapReturnType ReturnType
    Member of [Namespace].MapOptions

Remarks

  • If the ReturnType property is set to ReturnImage (the default), the returned MapImage.MimeData property contains the image and the MapImage.Url property is null.
  • If the ReturnType property is set to ReturnSecureUrl or ReturnUrl, the returned MapImage.Url property contains a URL (either secure or standard hypertext protocol) and the MapImage.MimeData property is null.
  • A returned URL is valid for returning up to ten images within five minutes of the call to the GetMap method. After five minutes or ten images (whichever occurs first), accessing the URL returns a session time out message. For more information about working with URLs, see Using MapPoint Web Service in a Web Application.

Example

 
[Visual Basic] 
'This example assumes that the service instance 
''renderService' has already been created and that 
'the MapPoint Web Service namespace has been imported 

'Return a URL to the map instead of the whole image
Dim myViews(0) As ViewByHeightWidth
myViews(0) = New ViewByHeightWidth()
myViews(0).CenterPoint = New LatLong()
myViews(0).CenterPoint.Latitude = 40
myViews(0).CenterPoint.Longitude = -120
myViews(0).Height = 200
myViews(0).Width = 300

Dim mapSpec As New MapSpecification()
mapSpec.DataSourceName = "MapPoint.NA"
mapSpec.Views = myViews
mapSpec.Options = New MapOptions()
mapSpec.Options.ReturnType = MapReturnType.ReturnUrl

Dim mapImages() As MapImage
mapImages = renderService.GetMap(mapSpec)

Image1.ImageUrl = mapImages(0).Url

 
[C#]
//This example assumes that the service instance 
//'renderService' has already been created and that 
//the MapPoint Web Service namespace has been imported 

//Return a URL to the map instead of the whole image
ViewByHeightWidth[] myViews = new ViewByHeightWidth[1];
myViews[0] = new ViewByHeightWidth();
myViews[0].CenterPoint = new LatLong();
myViews[0].CenterPoint.Latitude = 40;
myViews[0].CenterPoint.Longitude = -120;
myViews[0].Height = 200;
myViews[0].Width = 300;

MapSpecification mapSpec  = new MapSpecification();
mapSpec.DataSourceName = "MapPoint.NA";
mapSpec.Views = myViews;
mapSpec.Options = new MapOptions();
mapSpec.Options.ReturnType = MapReturnType.ReturnUrl;

MapImage[] mapImages;
mapImages = renderService.GetMap(mapSpec);

Image1.ImageUrl = mapImages[0].Url;

 

See Also

MapOptions Class | RenderServiceSoap.GetMap Method | MapReturnType Enumeration | MapImage.MimeData Property | MapImage.Url Property | Using MapPoint Web Service in a Web Application