pmMDA.NET

HostRemotingHandler.RetrievePaged Method (Type, Int32, Int32)

[This is preliminary documentation and subject to change.]

Retrieves the data objects tree using paging.

public PagedReadOnlyCollection RetrievePaged(
   Type type,
   int reloadAmount,
   int maxLoadedItemCount
);

Parameters

type
The type of the requested data objects.
reloadAmount
The number of items that are reloaded in one bunch when an unloaded item is requested.
maxLoadedItemCount
The maximal count of items which are hold in memory.

Return Value

A read only collectio which allows to access all the existing root data objects.

Implements

IRemotingHandler.RetrievePaged

Remarks

The returned collection allows to iterate over all items or a subset of all items. See the PagedReadOnlyCollection for further information about its features.

Retrieving root objects using paging is useful if there are a lot of root objects from the specified type. The items of the returned collection are only loaded if they are requested. A paged collection also optimises the used memory by freeing loaded items if the loaded item count exceeds the maxLoadedItemCount.

The is read only. This means that it is impossible to add or remove items from the returned collection. Root objects are created and removed use the and methods.

It is allowed to modify the items of a paged collection. It is also allowed to add new or existing data objects to items of the returned collection using the properties and indexed properties of the items.

The which contains modified items is stored using the method.

See Also

HostRemotingHandler Class | PmMda.Net.Dog.Remoting Namespace | HostRemotingHandler.RetrievePaged Overload List | PagedReadOnlyCollection | Store | Remove | data objects | PagedReadOnlyCollection | Store | data objects