company logo

Property :: changeBuffer - Change collection buffer count

In order to improve client/server performance, buffered access can be enabled. In this case, the buffer is filled completely on the server side and passed in one package to the client.

Buffered access is supported only for properties opened in read mode. Otherwise the function throws an exception. In local mode, buffered access can be activated as well but is not suggested.

The function allocates a buffer to the property handle, i.e. the number of instances that will be read at once. When a buffer has already been allocated you can use the function to change the buffer size. Passing 0 or 1 will change from buffered read to none buffered access (same as releaseBuffer()).

When passing -1 in iBufferSize the number of instances stored in the collection is determining the buffer size. Thus, one may read always the complete collection into buffer. Passing a number lower than -1 in iBufferSize the function throws an exception.

After calling the function, no instance is selected for the property handle.

Return value:  Number of instance buffers ( int32  )

This is the maximum number of instance buffers.

Implementation details

int32 Property  :: changeBuffer ( int32 iBufferSize )
  • iBufferSize - Number of instance buffers

    This is the maximum number of instance buffers.