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


ISMRouterFactory.CreateRouter Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (DataSourcesFile)  

ISMRouterFactory.CreateRouter Method

Creates a SMRouter object based on information in the input routing initialization file.

[Visual Basic .NET]
Public Function CreateRouter ( _
    ByVal RoutingFilePath As String _
) As SMRouter
[C#]
public SMRouter CreateRouter (
    string RoutingFilePath
);
[C++]
HRESULT CreateRouter(
  BSTR RoutingFilePath,
  ISMRouter** pIRouter
);
[C++]

Parameters RoutingFilePath [in] RoutingFilePath is a parameter of type BSTR pIRouter [out, retval]
pIRouter is a parameter of type ISMRouter

Product Availability

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

Description

The method creates a SMRouter object reading necessary information from the routing initialization file that is passed in.

Remarks

The method returns an instance of the SMRouter object if successful. Otherwise it returns Nothing.


A routing initialization file, for example routing.ini or routing.rs, contains the definition of the routing service based on the specific information about routing data source.

See Also

ISMRouterFactory Interface