Get a batch of uninitialized collection keys for a given role

Namespace:  NHibernate.Engine
Assembly:  NHibernate (in NHibernate.dll)

Syntax

Visual Basic (Declaration)
Public Function GetCollectionBatch ( _
	collectionPersister As ICollectionPersister, _
	id As Object, _
	batchSize As Integer _
) As Object()
C#
public Object[] GetCollectionBatch(
	ICollectionPersister collectionPersister,
	Object id,
	int batchSize
)
Visual C++
public:
array<Object^>^ GetCollectionBatch(
	ICollectionPersister^ collectionPersister, 
	Object^ id, 
	int batchSize
)
JavaScript
function getCollectionBatch(collectionPersister, id, batchSize);

Parameters

collectionPersister
Type: NHibernate.Persister.Collection..::.ICollectionPersister
The persister for the collection role.
id
Type: System..::.Object
A key that must be included in the batch fetch
batchSize
Type: System..::.Int32
the maximum number of keys to return

Return Value

an array of collection keys, of length batchSize (padded with nulls)

See Also