Bag(T).GetRepresentativeItem Method

BagTGetRepresentativeItem Method

Returns the representative item stored in the bag that is equal to the provided item. Also returns the number of copies of the item in the bag.

Namespace: X3Platform.Collections
Assembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)

Syntax

public int GetRepresentativeItem(
	T item,
	out T representative
)

public:
int GetRepresentativeItem(
	T item, 
	[OutAttribute] T% representative
)

item: Type: T
Item to find in the bag.
representative: Type: T
If one or more items equal to item are present in the bag, returns the representative item. If no items equal to item are stored in the bag, returns item.

Type: Int32
The number of items equal to item stored in the bag.