Functions that manipulate an LO handle
The following table shows the smart-large-object functions
that act on an LO handle, not on the smart large object that it identifies.
| DataBlade® API function | Purpose |
|---|---|
| mi_get_lo_handle() | Obtains an LO handle from a user-defined buffer |
| mi_lo_alter() | Alters the storage characteristics of the smart large object that the LO handle identifies |
| mi_lo_copy() | Copies the contents of a smart large object (that an LO handle identifies) into a new smart large object and initializes the LO handle of the new smart large object |
| mi_lo_create() | Creates a new smart large object and initializes its LO handle |
| mi_lo_decrefcount() | Decrements the reference count of the smart large object that the LO handle identifies |
| mi_lo_expand() (deprecated) | Copies multirepresentational data into a new smart large object and initializes the LO handle |
| mi_lo_filename() | Returns the name of the file where the mi_lo_to_file() function would store the smart large object that the LO handle identifies |
| mi_lo_from_buffer() | Copies a specified number of bytes from a user-defined buffer into a smart large object that the LO handle identifies |
| mi_lo_from_file() | Copies the contents of an operating-system file to a smart large object that the LO handle identifies |
| mi_lo_from_string() | Converts an LO handle from its text representation to its binary representation |
| mi_lo_increfcount() | Increments the reference count of the smart large object that the LO handle identifies |
| mi_lo_invalidate() | Marks an LO handle as invalid |
| mi_lo_lolist_create() | Converts an array of LO handles into an MI_LO_LIST structure |
| mi_lo_open() | Opens the smart large object that the LO handle identifies |
| mi_lo_ptr_cmp() | Compares two LO handles to see if they identify the same smart large object |
| mi_lo_release() | Releases resources held by a transient smart large object, including its LO handle |
| mi_lo_to_buffer() | Copies a specified number of bytes from a smart large object that the LO handle identifies into a user-defined buffer |
| mi_lo_to_file() | Copies the smart large object that the LO handle identifies to an operating-system file |
| mi_lo_to_string() | Converts an LO handle from its binary representation to its text representation |
| mi_lo_validate() | Checks whether an LO handle is valid |
| mi_put_lo_handle() | Puts an LO handle into a user-defined buffer Restriction: The LO handle, MI_LO_HANDLE, is an opaque
structure to DataBlade
API modules.
Do not access its internal structure directly. There is no guarantee
that the internal structure of MI_LO_HANDLE will not change.
To create portable code, use the appropriate DataBlade
API function
to access this structure. |