Asynchronously gets the LocationNames by name.
Namespace: ININ.IceLib.TrackerAssembly: ININ.IceLib.Tracker (in ININ.IceLib.Tracker.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void GetLocationNamesByNameAsync( long isPrivate, string ownerId, string organizationId, string locationName, EventHandler<QueryCollectionResultCompletedEventArgs<LocationName>> completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub GetLocationNamesByNameAsync ( _ isPrivate As Long, _ ownerId As String, _ organizationId As String, _ locationName As String, _ completedCallback As EventHandler(Of QueryCollectionResultCompletedEventArgs(Of LocationName)), _ userState As Object _ ) |
Parameters
- isPrivate
- Type: System..::..Int64
Whether it is private.
- ownerId
- Type: System..::..String
The owner ID.
- organizationId
- Type: System..::..String
The ID of the Organization.
- completedCallback
- Type: System..::..EventHandler<(Of <(<'QueryCollectionResultCompletedEventArgs<(Of <(<'LocationName>)>)>>)>)>
The callback to invoke when the asynchronous operation completes.
- userState
- Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.
Remarks
If locationName is empty, all known LocationNames are returned (while still considering isPrivate and ownerId). Otherwise, locationName is treated like a wildcard.
When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.