cl_alloc_clustermap routine

The cl_alloc_clustermap routine allocates storage for a list of clusters. This routine must be called before calling the cl_getclusters routine.

After calling the cl_getclusters routine, call the cl_free_clustermap routine to free the storage.

Syntax

int cl_alloc_clustermap (struct cl_cluster **clustermap)

Parameters

Item Description
clustermap The base pointer for the clustermap.

Status codes

Item Description
CLE_OK The request completed successfully.
CLE_BADARGS Missing or invalid parameters. This status usually indicates that a NULL pointer was specified for the clustermap argument.

Example

See the example for the see cl_getclusters routine.