NWSMListSMDRs

Returns the names of all active SMDRs.

Syntax

  #include <smsdrapi.h> 
   
  CCODE NWSMListSMDRs ( 
     char *pattern, 
     NWSM_NAME_LIST **tsaNameList);

Parameters

pattern

(IN) Specifies the pattern:

  • “*” Return all SMDR names
  • “*xxxx” Return all SMDR names that end with “xxxx”
  • “xxxx*” Return all SMDR names that begin with “xxxx”
  • “xxxx” Find the SMDR named “xxxx”
tsaNameList

(OUT) Points to a block of memory containing the list of specified SMDRs (cannot be a NULL pointer but can be a pointer set to a NULL pointer).

Return Values

The following table lists the return values associated with the function.

0x00000000

Successful

0xFFFBFFFB

NWSMUT_OUT_OF_MEMORY

0xFFFEFFF6

NWSMDR_NO_SUCH_SMDR

0xFFFEFFFE

NWSMDR_INVALID_PARAMETER

0xFFFEFFE9

NWSMDR_INVALID_CONTEXT

Remarks

For clusters, the virtual NCP server name is listed.

After an SMDR name is selected, it is passed to NWSMListTSAs to find the available TSAs that are local to that SMDR. The SMDR name is the same as the Target Service's name. NWSMListSMDRs may speed up the listing of SMS modules.

Call NWSMFreeNameList to free the memory allocated to nameList.