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)

Syntax

'Declaration
Function ConfigureAccessMapping ( _
    moniker As String, _
    displayName As String, _
    accessPoint As String, _
    makeDefault As Boolean _
) As AccessMapping

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

AccessMapping^ ConfigureAccessMapping(
    String^ moniker, 
    String^ displayName, 
    String^ accessPoint, 
    bool makeDefault
)

abstract ConfigureAccessMapping : 
        moniker:string * 
        displayName:string * 
        accessPoint:string * 
        makeDefault:bool -> AccessMapping

function ConfigureAccessMapping(
    moniker : String, 
    displayName : String, 
    accessPoint : String, 
    makeDefault : boolean
) : AccessMapping

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: https://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.

Exceptions

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

ILocationService Interface

Microsoft.TeamFoundation.Framework.Client Namespace