NWSMInitList

Initializes a list head for an NWSM_LIST list, and sets the functions to use in the list.

Syntax

  #include <smsutapi.h> 
   
  void NWSMInitList ( 
     NWSM_LIST_PTR  *listPtr, 
     void            (*freeRoutine) 
      (void *memoryPointer));
  

Parameters

listPtr

(IN/OUT) Points to an NWSM_LIST_PTR structure.

freeRoutine

(IN) Points to the routine to free the memory associated with each element's otherInfo field.

Remarks

NWSMDestroyList uses NWSMInitList to help destroy the list.

NWSMInitList initializes a list head structure as follows:

  head = tail = NULL 
  sortProc = stricmp 
  freeProcedure = freeRoutine
  

You can set sortProc to another compare function.

To get the current list head, call NWSMGetListHead. To build the list, call NWSMAppendToList.

If the list element's otherInfo field contains a non-allocated value, freeRoutine must be set to NULL. However, this routine will not free the memory allocated to otherInfo.

See Also

NWSMAppendToList, NWSMDestroyList