NWSMPutOneName

Places one data set name into a data set name list or a selection list.

Syntax

  #include <smsutapi.h> 
   
  CCODE NWSMPutOneName ( 
     void HUGE   **buffer, 
     UINT32        nameSpaceType, 
     UINT32        selectionType, 
     NWBOOLEAN     reverseOrder, 
     void         *sep1, 
     void         *sep2, 
     void         *name);
  

Parameters

buffer

(OUT) Points to the NWSM_DATA_SET_NAME_LIST or NWSM_SELECTION_LIST structure to receive the data set name.

nameSpaceType

(IN) Specifies the name space type of name (see nameSpaceType Values).

selectionType

(IN) Specifies the selection type for a selection list (see selectionType Values).

reverseOrder

(IN) Specifies the order of the characters in name, sep1, and sep2, when placed into buffer as returned by NWSMTSGetNameSpaceTypeInfo:

  • TRUE Reverse the names
  • FALSE Do not reverse the names
sep1

(IN) Points to the first separator used for paths in the specified name space as returned by NWSMTSGetNameSpaceTypeInfo.

sep2

(IN) Points to the second separator used for paths in the specified name space as returned by NWSMTSGetNameSpaceTypeInfo.

name

(IN) Points to the name of the data set as it exists in the specified name space.

Return Values

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

0x00000000

Successful

0xFFFBFFFB

NWSMUT_OUT_OF_MEMORY

0xFFFBFFFD

NWSMUT_INVALID_PARAMETER

0xFFFBFFFF

NWSMUT_INVALID_HANDLE

0xFFFBFFFA

NWSMUT_BUFFER_OVERFLOW: The list of names or paths is greater than 255.

Remarks

NWSMPutOneName destroys the existing name list in buffer, puts one data set name into buffer, and sets the name list count to one.

NWSMPutOneName is similar to NWSMPutOneLName. However, NWSMPutOneLName requires the length of the data set name.

NWSMPutOneName also supports data set names in Unicode format.

NWSMPutOneName can build the resourceName parameter for NWSMTSScanDataSetBegin.

If there is not enough space for the name, the buffer is resized. If buffer is set to NULL, memory is allocated to it. You are responsible to free the memory allocated by buffer.

If buffer contains a data set name list, selectionType must be set to zero. If buffer contains a selection list, selectionType must be set to a selection type.

If reverseOrder is TRUE, C:\\SYSTEM\\TEMP.EXE would be EXE.TEMP\\SYSTEM\\:C.

Set nameSpaceType to NWSM_TSA_DEFINED_RESOURCE if name was returned by NWSMTSListTSResources.