API Reference
Class
PortInventoryQueryExecutor
Executes typed port inventory queries.
Inheritance
- Object
- PortInventoryQueryExecutor
Methods
public static PortInventoryQueryResult Execute(PortInventoryQueryRequest request, CancellationToken cancellationToken = null) #Returns:
PortInventoryQueryResultExecutes a port inventory query.
Parameters
- request ComputerX.Ports.PortInventoryQueryRequest
- Query request.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Typed query result.
public static Task<PortInventoryQueryResult> ExecuteAsync(PortInventoryQueryRequest request, CancellationToken cancellationToken = null) #Returns:
Task<PortInventoryQueryResult>Executes a port inventory query asynchronously.
Parameters
- request ComputerX.Ports.PortInventoryQueryRequest
- Query request.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Typed query result.
TryExecute 2 overloads
public static PortInventoryQueryTryResult TryExecute(PortInventoryQueryRequest request, CancellationToken cancellationToken = null) #Returns:
PortInventoryQueryTryResultNon-throwing port inventory query wrapper.
Parameters
- request ComputerX.Ports.PortInventoryQueryRequest
- Query request.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Success/failure envelope with typed failure details.
public static Boolean TryExecute(PortInventoryQueryRequest request, out PortInventoryQueryResult result, out PortInventoryQueryFailure failure, CancellationToken cancellationToken = null) #Returns:
BooleanNon-throwing synchronous port inventory query wrapper with out parameters.
Parameters
- request ComputerX.Ports.PortInventoryQueryRequest
- Query request.
- result ComputerX.Ports.PortInventoryQueryResult@
- Query result on success.
- failure ComputerX.Ports.PortInventoryQueryFailure@
- Typed failure on error.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
True on success; otherwise false.
public static Task<PortInventoryQueryTryResult> TryExecuteAsync(PortInventoryQueryRequest request, CancellationToken cancellationToken = null) #Returns:
Task<PortInventoryQueryTryResult>Non-throwing asynchronous port inventory query wrapper.
Parameters
- request ComputerX.Ports.PortInventoryQueryRequest
- Query request.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Success/failure envelope with typed failure details.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object