TheStorageMirror<(Of <(<'T>)>)>..::..GetRecords Method (String, Int32, Int32, String, Action<(Of <(<'StoreResponse>)>)>, Boolean, Boolean, Object)

Retrieves records from the StorageMirror's underlying MirrorCache or IStorageService and hands them to the callback. If IsRAMStore or IsCached, the records will be retrieved from the MirrorCache. If IsRAMStore is false, the records will be retrieved from the IStorageService.

Namespace: nsCDEngine.Engines.StorageService
Assembly: C-DEngine (in C-DEngine.dll)

Syntax

C++

public bool GetRecords(
	string SQLFilter,
	int TopRows,
	int PageNumber,
	string SQLOrder,
	Action<TheStorageMirror<(Of <(<'T>)>)>..::..StoreResponse> pCallBack,
	bool LocalCallBackOnly,
	bool InitIfNotInit,
	Object pCookie
)

Public Function GetRecords ( _
	SQLFilter As String, _
	TopRows As Integer, _
	PageNumber As Integer, _
	SQLOrder As String, _
	pCallBack As Action(Of TheStorageMirror<(Of <(<'T>)>)>..::..StoreResponse), _
	LocalCallBackOnly As Boolean, _
	InitIfNotInit As Boolean, _
	pCookie As Object _
) As Boolean

public:
bool^ GetRecords(
	String^ SQLFilter, 
	int^ TopRows, 
	int^ PageNumber, 
	String^ SQLOrder, 
	Action<TheStorageMirror<(Of <(<'T>)>)>..::..StoreResponse^>^ pCallBack, 
	bool^ LocalCallBackOnly, 
	bool^ InitIfNotInit, 
	Object^ pCookie
)

Parameters

SQLFilter: Type: String
The "WHERE" clause to filter the records returned. Generally the filter should consist of the form [PropertyName] [Operation] [Value], e.g. FriendlyName = "MyThing"

TopRows: Type: Int32
The maximum number of records to return from the query

PageNumber: Type: Int32
The page number for the query, if the IStorageService supports a paging mechanism. Note that this is only used for retrieval from the IStorageService and not the MirrorCache.

SQLOrder: Type: String
The "ORDER BY" clause to order the records returned. Generally the string should consist of the form [PropertyName] [desc | asc], e.g. cdeCTIM desc

pCallBack: Type: Action<(Of <(<'TheStorageMirror<(Of <(<'T>)>)>..::..StoreResponse>)>)>
The callback method that will be invoked upon error or completed retrieval of records.

LocalCallBackOnly: Type: Boolean
If set to true, no request is sent to a remote StorageService.

InitIfNotInit: Type: Boolean
If the StorageMirror is not ready yet and this value is true, InitializeStore will be called before proceeding with the request.

pCookie: Type: Object
A cookie that will later be returned with the StoreResponse in the callback.

Return Value

True if the request was successfully made and false otherwise (if the StorageMirror is not ready yet and was not initialized).

TheStorageMirror<(Of <(<'T>)>)>..::..GetRecords Method (String, Int32, Int32, String, Action<(Of <(<'StoreResponse>)>)>, Boolean, Boolean, Object)

Syntax

Parameters

Return Value

See Also