ItemServicesFindItems Method |
Searches the FactoryLogix database for
Items matching the specified criteria.
Namespace:
FactoryLogix.xTend.Logistics
Assembly:
FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.245.0.0 (8.245.0.0)
Syntax public PagedSearchResults<Item> FindItems(
Guid sessionId,
ItemSearchCriteria[] searchCriteria,
ItemSortDirective[] sorting,
int pageSize,
int pageNumber
)
Public Function FindItems (
sessionId As Guid,
searchCriteria As ItemSearchCriteria(),
sorting As ItemSortDirective(),
pageSize As Integer,
pageNumber As Integer
) As PagedSearchResults(Of Item)
public:
virtual PagedSearchResults<Item^>^ FindItems(
Guid sessionId,
array<ItemSearchCriteria^>^ searchCriteria,
array<ItemSortDirective^>^ sorting,
int pageSize,
int pageNumber
) sealed
abstract FindItems :
sessionId : Guid *
searchCriteria : ItemSearchCriteria[] *
sorting : ItemSortDirective[] *
pageSize : int *
pageNumber : int -> PagedSearchResults<Item>
override FindItems :
sessionId : Guid *
searchCriteria : ItemSearchCriteria[] *
sorting : ItemSortDirective[] *
pageSize : int *
pageNumber : int -> PagedSearchResults<Item>
Parameters
- sessionId
- Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method. - searchCriteria
- Type: FactoryLogix.xTend.DataObjectsItemSearchCriteria
A list of ItemSearchCriteria objects describing the search parameters. - sorting
- Type: FactoryLogix.xTend.DataObjectsItemSortDirective
A list of ItemSortDirective objects describing how the search results should be sorted. - pageSize
- Type: SystemInt32
The maximum number of records to be returned by each single call to this method. This parameter must fall within a range of 0 to a maximum value of 500. If a value of 0 or null is specified, the default page size of 20 will be used. - pageNumber
- Type: SystemInt32
The page number of the result set to be retrieved when the search results in a result set greater than the page size. By default, a value of 1 will be used if this parameter is null or 0. A value of -1 indicates that the last page is desired.
Return Value
Type:
PagedSearchResultsItemA
PagedSearchResultsT object containing 1 page worth of search results, where T is of type
Item. If the result set of the search is greater than the page size, the return object contains the total number of pages which may be used by subsequent calls to retrieve more pages worth of result data.
Exceptions See Also