NCS_ListResources

Lists available resources.

Syntax

 #include <ncssdk.h> 
  
 NCS_RETURN NCS_ListResources (
   NCS_HANDLE      Handle,
   UINT32         *NumResources,
   NCS_RESOURCE   *ResArray[]);
 

Parameters

Handle

(IN) Specifies the current NCS handle.

NumResources

(IN/OUT) On input, specifies the number of resources (maximum 256 in any cluster) that can be read in ResArray. On output, shows the number of resources that were filled in ResArray.

HINT:On input, you should specify the actual number of resources used by the cluster. To determine the actual size of the resource array in the cluster, use NCS_NumberResources. You then allocate the required amount of memory required by the array, then pass in the array to NCS_ListResources.

ResArray

(OUT) Points to an array of pointers to NCS_RESOURCE.

Return Values

Name

Description

SUCCESS

NCS_SUCCESS.

FAILURE

See NDS Error Codes.

NCS_BAD_PARAMETER

See NDS Error Codes.

Remarks

Call NCS_ListResources after NCS_NumberResources. ResArray points to an array of pointers to NCS_RESOURCE size buffers. NumResources will hold how many (maximum of 256) resources to read. Each buffer has the name and uniObjName (see NCS_RESOURCE) fields filled.