The a_v4_extfn_describe_return enumerated type provides a return value, when a_v4_extfn_proc_context.describe_xxx_get() or a_v4_extfn_proc_context.describe_xxx_set() does not succeed.
typedef enum a_v4_extfn_describe_return {
EXTFNAPIV4_DESCRIBE_NOT_AVAILABLE = 0, // the specified operation has no meaning either for this attribute or in
the current context.
EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH = -1, // the provided buffer size does not match the required length or the
length is insufficient.
EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER = -2, // the provided parameter number is invalid
EXTFNAPIV4_DESCRIBE_INVALID_COLUMN = -3, // the column number is invalid for this table parameter
EXTFNAPIV4_DESCRIBE_INVALID_STATE = -4, // the describe method call is not valid in the present state
EXTFNAPIV4_DESCRIBE_INVALID_ATTRIBUTE = -5, // the attribute is known but not appropriate for this object
EXTFNAPIV4_DESCRIBE_UNKNOWN_ATTRIBUTE = -6, // the identified attribute is not known to this server version
EXTFNAPIV4_DESCRIBE_NON_TABLE_PARAMETER = -7, // the specified parameter is not a table parameter (for describe_col_get()
or set())
EXTFNAPIV4_DESCRIBE_INVALID_ATTRIBUTE_VALUE = -8, // the specified attribute value is illegal
EXTFNAPIV4_DESCRIBE_LAST = -9
} a_v4_extfn_describe_return;
| Member | Return Value | Description |
|---|---|---|
| EXTFNAPIV4_DESCRIBE_NOT_AVAILABLE | 0 | The specified operation has no meaning either for this attribute or in the current context. |
| EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH | -1 | The provided buffer size does not match the required length, or the length is insufficient. |
| EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER | -2 | The provided parameter number is invalid. |
| EXTFNAPIV4_DESCRIBE_INVALID_COLUMN | -3 | The column number is invalid for this table parameter. |
| EXTFNAPIV4_DESCRIBE_INVALID_STATE | -4 | The describe method call is invalid in the present state. |
| EXTFNAPIV4_DESCRIBE_INVALID_ATTRIBUTE | -5 | The attribute is known but not appropriate for this object. |
| EXTFNAPIV4_DESCRIBE_UNKNOWN_ATTRIBUTE | -6 | The identified attribute is not known to this server version. |
| EXTFNAPIV4_DESCRIBE_NON_TABLE_PARAMETER | -7 | The specified parameter is not a table parameter (for describe_col_get() or describe_col_set()). |
| EXTFNAPIV4_DESCRIBE_INVALID_ATTRIBUTE_VALUE | -8 | The specified attribute value is illegal. |
| EXTFNAPIV4_DESCRIBE_LAST | -9 | First illegal value for v4 API. |
The return value of a_v4_extfn_proc_context.describe_xxx_get() and a_v4_extfn_proc_context.describe_xxx_set() is a signed integer. If the result is positive, the operation succeeds, and the value is the number of bytes copied. If the return value is less or equal to zero, the operation does not succeed, and the return value is one of the a_v4_extfn_describe_return values.