Retrieves the content of a binary large object.
If the binary large object is to be retrieved in multiple chunks, chunks are retrieved in sequence, where the length of each chunk is specified by the length parameter of each call to this routine. Chunks may only be retrieved sequentially through the binary large object.
Parameters
MimerLob *blobhandle,
void *data,
size_t size)
|
blobhandle |
in |
A reference to a binary large object handle created by MimerGetLob. |
|
data |
out |
Where to place the entire or a part of the binary large object. |
|
size |
in |
The size in bytes to retrieve in this chunk. |
Returns
A negative value indicating error, or a non-negative value indicating the number of bytes available to return.
|
Return value |
Description |
|---|---|
|
>= 0 |
The number of bytes available to return. This includes the number of bytes returned in this call and all data that are left in the BLOB. When the returned value is equal or less than the size input parameter, all data of the BLOB has been returned. |
|
MIMER_HANDLE_INVALID |
The blobhandle parameter was not recognized as a handle. |
|
MIMER_OUTOFMEMORY |
If not enough memory could be allocated. |
|
Other value < 0 |
Any of the server error codes listed in Return Codes. |
Notes
This routine interacts with the database server.
Not Micro API compatible.