Entity.FindEntitiesByNameInHierarchy(String, StringComparison, 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.
Traverses the entity's sub graph (including this entity) and returns a list of entities that have a matching name.
public:
System::Collections::Generic::IReadOnlyList<Microsoft::Azure::RemoteRendering::Entity ^> ^ FindEntitiesByNameInHierarchy(System::String ^ name, Microsoft::Azure::RemoteRendering::StringComparison comparison, int maxResultCount);public System.Collections.Generic.IReadOnlyList<Microsoft.Azure.RemoteRendering.Entity> FindEntitiesByNameInHierarchy (string name, Microsoft.Azure.RemoteRendering.StringComparison comparison, int maxResultCount);member this.FindEntitiesByNameInHierarchy : string * Microsoft.Azure.RemoteRendering.StringComparison * int -> System.Collections.Generic.IReadOnlyList<Microsoft.Azure.RemoteRendering.Entity>Public Function FindEntitiesByNameInHierarchy (name As String, comparison As StringComparison, maxResultCount As Integer) As IReadOnlyList(Of Entity)Parameters
- name
- String
The name to compare against.
- comparison
- StringComparison
A pre-defined string comparison method, see StringComparison.
- maxResultCount
- Int32
If larger than 0, this value specifies the maximum number of returned elements. For negative values or 0, no size limit is imposed.
Returns
The array of found elements, or an empty array.
Remarks
If you only need the first result, then maxResultCount should be set to 1, so the search function can return early.