Entity.GetRootPath(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns the path string to this entity, starting at the root entity. A path is a sequence of entity names, separated by a special path delimiter character/string. A possible path may look like this: "root/house/table/leg4".
public:
System::String ^ GetRootPath(System::String ^ pathSeparator);public string GetRootPath (string pathSeparator);member this.GetRootPath : string -> stringPublic Function GetRootPath (pathSeparator As String) As StringParameters
- pathSeparator
- String
A single character (or non-empty string) that is inserted between the entity names. For instance, use "/" or "".
Returns
The string that describes the path.
Remarks
The path separator should be chosen carefully, so it's not a potential character sequence in entity names. To describe the relative path between a parent and an entity underneath it, just take the root path of both and trim the start of the path string of the child by the length of the parent's path plus separator length.