ChangeLocationName Method

In This Topic

Changes name of the given location. After that change a location object becomes invalid, to get this object once again, use the GetLocationObjects function.

Syntax

C#
C++/CLI

public Location ChangeLocationName( 
   Location oLocation,
   string strName
)

public:
Location^ ChangeLocationName( 
   Location^ oLocation,
   String^ strName
)

Parameters

oLocation: Location object.
strName: New name of a location.

Return Value

Location object.

Exceptions

Exception	Description
ObjectNotCreatedException	Thrown when a location is not created.
IncorrectNameFormatException	Thrown when a location name contains special '.' character.

Remarks

The project must be opened in exclusive mode.

Reference

Project Class
Project Members

Send Feedback