This documentation is archived and is not being maintained.

ILocationService.ConfigureAccessMapping Method

Configures the AccessMapping with the provided moniker to have the provided display name and access point. This function also allows for this AccessMapping to be made the default AccessMapping.

Namespace:  Microsoft.TeamFoundation.Framework.Client
Assembly:  Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

AccessMapping ConfigureAccessMapping(
	string moniker,
	string displayName,
	string accessPoint,
	bool makeDefault
)

Parameters

moniker
Type: System.String

A string that uniquely identifies this AccessMapping. This value cannot be null or empty.

displayName
Type: System.String

Display name for this AccessMapping. This value cannot be null or empty.

accessPoint
Type: System.String

This is the base url for the server that will map to this AccessMapping. This value cannot be null or empty. The access point should consist of the scheme, authority, port and web application virtual path of the targetable server address. For example, an access point will most commonly look like this: http://server:8080/tfs/

makeDefault
Type: System.Boolean

If true, this AccessMapping will be made the default AccessMapping. If false, the default AccessMapping will not change.

Return Value

Type: Microsoft.TeamFoundation.Framework.Client.AccessMapping
The AccessMapping object that was just configured.

ExceptionCondition
InvalidAccessPointException

Thrown if the access point for this AccessMapping is invalid or if it conflicts with an already registered access point.

Show: