1NODEUPDOWN_GET_UP_NODES_STRING(3)LIBNODEUPDOWNNODEUPDOWN_GET_UP_NODES_STRING(3)
2
3
4
6 nodeupdown_get_up_nodes_string, nodeupdown_get_down_nodes_string, - get
7 up or down nodes
8
10 #include <nodeupdown.h>
11
12 int nodeupdown_get_up_nodes_string(nodeupdown_t handle, char *buf, int
13 buflen);
14
15 int nodeupdown_get_down_nodes_string(nodeupdown_t handle, char *buf,
16 int buflen);
17
19 nodeupdown_get_up_nodes_string() retrieves a ranged string of nodes
20 that are up and places it in the buffer pointed to by buf. buflen
21 should indicate the length of the buffer. nodeup‐
22 down_get_down_nodes_string() is identical to nodeup‐
23 down_get_up_nodes_string(), except that it retrieves a ranged string of
24 down nodes.
25
27 On success, 0 is returned. On error, -1 is returned, and an error code
28 is returned in handle. The error code can be retrieved via nodeup‐
29 down_errnum(3) , and a description of the error code can be retrieved
30 via nodeupdown_strerror(3). Error codes are defined in nodeupdown.h.
31
33 NODEUPDOWN_ERR_NULLHANDLE
34 The handle parameter is NULL. The nodeupdown handle must be
35 created with nodeupdown_handle_create(3).
36
37 NODEUPDOWN_ERR_NOTLOADED
38 nodeupdown_load_data(3) has not been called and no data has been
39 retrieved.
40
41 NODEUPDOWN_ERR_PARAMETERS
42 An incorrect parameter has been passed in.
43
44 NODEUPDOWN_ERR_OVERFLOW
45 The buffer pointed to by buf is not large enough to store the
46 ranged string of nodes.
47
48 NODEUPDOWN_ERR_OUTMEM
49 malloc(3) has failed internally.
50
51 NODEUPDOWN_ERR_CLUSTERLIST_MODULE
52 Internal error with the clusterlist module
53
54 NODEUPDOWN_ERR_HOSTLIST
55 Hostlist API has failed internally.
56
57 NODEUPDOWN_ERR_MAGIC
58 handle has an incorrect magic number. handle does not point to
59 a nodeupdown handle or handle has been destroyed by nodeup‐
60 down_handle_destroy(3).
61
63 /usr/include/nodeupdown.h
64
66 libnodeupdown(3), nodeupdown_handle_create(3), nodeupdown_load_data(3),
67 nodeupdown_get_up_nodes_list (3), nodeupdown_get_down_nodes_list (3),
68 nodeupdown_errnum(3), nodeupdown_strerror(3)
69
70
71
72LLNL August 2003NODEUPDOWN_GET_UP_NODES_STRING(3)