user_add_to_desc

[cf]user_add_to_desc

int user_add_to_desc(void *user, int *desc_size, char **desc)

Description:

Before a node description is sent to the TM, the user can provide a pointer to a data structure that will be appended to the description for later use by the user in reconstruction of the node. This information must be placed into *desc. Its size should be returned in *desc_size.

There is only one default option: the description to be added is considered to be of zero length, i.e., there is no additional description.

Arguments:

void *user	IN	Pointer to the user-defined LP data structure.
int *desc_size	OUT	The size of the additional information, the length of *desc in bytes.
char **desc	OUT	Pointer to the additional information (space must be allocated by the user).

Return values:

USER_ERROR	Error. DEFAULT is used.
USER_SUCCESS	User filled out *desc_size and *desc.
USER_DEFAULT	No description is appended.

Wrapper invoked from:

create_explicit_node_desc() before a node is sent to the tree manager.