Filter:C# VB.NET C++ (.NET) Java PHP C++ Delphi / Pascal (VCL) C++Builder (VCL)
Retrieves information about objects on the server
[Delphi / Pascal (VCL)]
function GetObjectInfo( RestartFrom : integer; RetrieveCount : integer; out Info : array of TObjectInfo ) : integer;
- RestartFrom - Starting index of ObjectInfo, for which retrieval is performed
- RetrieveCount - The number of objects about which information is retrieved (0 - retrieve information about all objects)
- Info - On return contains array of ObjectInfo objects to be sent to the client
0 if the method succeeded or one of defined error codes in case of failure.
This method retrieves information about objects, available on the server.
After the method is executed and if the server reported success, Status property of each ObjectInfo in the list must contain result of retrieval operation (retrieved OK or the object was locked). ObjectID and ObjectHash properties of each ObjectInfo must be filled. ObjectData is not filled and is not sent to the client.
RestartFrom and RetrieveCount are used to perform the operation only on subset of objects (for better fault-tolerance and resumption of process).
Object class must be locked by the client before any information that belongs to the class is synchronized, otherwise the server must return CLASS_NOT_LOCKED error.
If the implementation needs to add some information or status to the centralized log, it can use Log() method of Engine object provided in OpenSession() method.
Got questions or comments about this topic? Tell us about them.