KI_HANDLE_GET_ATTR_STR
| Argument | Enumeration | Purpose |
|---|---|---|
| handle | Table handle | |
| eAttr | KDB_HANDLE_ATTR_ENUM | attribute |
| sAttr$ | Buffer to receive attribute | |
| nLen | Length of string | |
| status | KDB_ERROR_ENUM | Return status |
KI_HANDLE_GET_ATTR_STR
This function is used to inspect string attributes of a database handle. Generally these attributes were set using the complementary KI_HANDLE_SET_ATTR_STR function after the handle has been allocated with KI_ALLOC_HANDLE. Handles also have numeric and boolean attributes that are set with KI_HANDLE_SET_ATTR and inspected with KI_HANDLE_GET_ATTR.
Valid attributes and the enumeration that define them may be found in this page and in the constants list here.
The length receiver nLen returns the actual length of the attribute even if the string was clipped to fit the available space in the given buffer. If the buffer is bigger than the attribute it will be space filled. If there is no attribute then the entire buffer will be blank and the length will be zero.