NWSMPutFirstName

Places the first data set name into a NWSM_DATA_NAME_LIST or NWSM_SELECTION_LIST structure.

Syntax

  #include <smsutapi.h> 
   
  CCODE NWSMPutFirstName ( 
     void SM_HUGE   **buffer, 
     UINT32        nameSpaceType, 
     UINT32        selectionType, 
     NWBOOLEAN     reverseOrder, 
     void         *sep1, 
     void         *sep2, 
     void         *name, 
     SMS_HANDLE SM_HUGE  *handle);
  

Parameters

buffer

(IN/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.

handle

(OUT) Points to the name handle to use for subsequent name insertion functions.

Return Values

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

0x00000000

Successful

0xFFFBFFFD

NWSMUT_INVALID_PARAMETER: name is NULL.

0xFFFBFFFB

NWSMUT_OUT_OF_MEMORY

0xFFFBFFFA

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

Remarks

NWSMPutFirstName allocates memory for buffer, clears the existing name list, and inserts one data set name into the name list. All appropriate fields in the buffer are updated to indicate the number of data set names in the name list.

NWSMPutFirstName can build a selection list or data set name list for NWSMTSScanDataSetBegin and NWSMTSScanDataSetNext.

NWSMPutFirstName is similar to NWSMPutFirstLName. However, NWSMPutFirstLName requires the length of the data set name.

NWSMPutFirstName also supports data set names in Unicode format.

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.

See Also

NWSMCloseName, NWSMPutFirstLName, NWSMPutNextLName, NWSMPutNextName