MvComponent.GetObjectIdsAsync Method

Requests the list of objects that have been registered with the server and whose names match the pattern. (See IlsString::match(), see also IlsMvServer::DeclObjectLabel() to know how to associate a Server object with a label.)

Namespace: RW.Server.Component
Assembly: RW.Server.Component (in RW.Server.Component.dll) Version: 6.3.0.0 (0.8.0.0)

Syntax

C++

Copy

public Task<ICollection<string>> GetObjectIdsAsync(
	string pattern,
	bool caseSensitive = false
)

Public Function GetObjectIdsAsync ( 
	pattern As String,
	Optional caseSensitive As Boolean = false
) As Task(Of ICollection(Of String))

public:
Task<ICollection<String^>^>^ GetObjectIdsAsync(
	String^ pattern, 
	bool caseSensitive = false
)

Parameters

pattern: Type: SystemString
The pattern (set this parameter to "" if you want to know the set of the registered server objects) .
caseSensitive (Optional): Type: SystemBoolean
Specifies whether the search should be case-sensitive.

Return Value

Type: TaskICollectionString
An asynchronous task that will contain a collection of the object ids.

Remarks

When the server has selected the list of matching objects, this list is filtered by a call to the server side function IlsViewed::acceptView() on each object of the list, with a view type name argument set to null.

Reference

MvComponent Class

RW.Server.Component Namespace