NCS_NumPools

Returns the number of pools to be reported.

Syntax

 #include <ncssdk.h> 
  
 NCS_RETURN NCS_NumPools (
   NCS_HANDLE   Handle, 
   UINT32      *NumPools);
 

Parameters

Handle

(IN) Specifies the application’s handle.

NumPools

(OUT) Points to the number of enabled pools in the cluster.

Return Values

Name

Description

SUCCESS

NCS_SUCCESS.

NCS_BAD_PARAMETER

See NDS Error Codes.

Remarks

Call this function to allocate memory NumPools before this function returns with the count of cluster enabled pools.

NOTE:If a cluster resource has a shared pool which hasn’t been cluster enabled, it doesn’t appear in this count.

NCS_NumPools is used to allocate the correct amount of memory for NCS_WherePools call.