Entity.FindByPath(String, StringComparison, String, Int32) 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 a list of entities that are under this entity and that match the exact search path. A path is a sequence of entity names, separated by a special path delimiter character/string. For instance, a path string could be "house/table/leg4". In that example, this function would search for direct child entities named "house", from there recursively search for child entities named "table" and so on. It only returns those entities that match the full path.
public:
System::Collections::Generic::IReadOnlyList<Microsoft::Azure::RemoteRendering::Entity ^> ^ FindByPath(System::String ^ path, Microsoft::Azure::RemoteRendering::StringComparison comparison, System::String ^ pathSeparator, int maxResultCount);public System.Collections.Generic.IReadOnlyList<Microsoft.Azure.RemoteRendering.Entity> FindByPath (string path, Microsoft.Azure.RemoteRendering.StringComparison comparison, string pathSeparator, int maxResultCount);member this.FindByPath : string * Microsoft.Azure.RemoteRendering.StringComparison * string * int -> System.Collections.Generic.IReadOnlyList<Microsoft.Azure.RemoteRendering.Entity>Public Function FindByPath (path As String, comparison As StringComparison, pathSeparator As String, maxResultCount As Integer) As IReadOnlyList(Of Entity)Parameters
- path
- String
The path string relative to this entity. The path separator character/string can be passed separately.
- comparison
- StringComparison
A pre-defined string comparison method to compare each path segment against an entity's name. See StringComparison.
- pathSeparator
- String
A single character (or non-empty string) that denotes a delimiter in the path string. For instance, use "/" or "".
- maxResultCount
- Int32
The maximum number of entities to find. Use 1 to return the first result only, or a negative number for all results.
Returns
The list of result entities that match the input path.
Remarks
The path separator should be chosen carefully, so it's not a potential character sequence in entity names.