NWSMTSParseDataSetName

Returns the number of path nodes and separators, and the beginning position of each path node and separator for a specified path.

Syntax

  #include <smstsapi.h> 
   
  CCODE NWSMTSParseDataSetName (
     UINT32           connection, 
     UINT32           nameSpaceType, 
     STRING           dataSetName, 
     UINT16          *count, 
     UINT16_BUFFER **namePositions, 
     UINT16_BUFFER **separatorPositions);
  

Parameters

connection

(IN) Specifies the connection information returned by NWSMTSConnectToTargetService or NWSMTSConnectToTargetServicEx.

nameSpaceType

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

dataSetName

(IN) Specifies the data set name to be parsed.

count

(OUT) Points to the number of nodes and separators in dataSetName (the size of the namePositions and separatorPositions buffers).

namePositions

(OUT) Points to an array of indexes containing the beginning of each node in dataSetName.

separatorPositions

(OUT) Points to an array of indexes containing the beginning of each separator in dataSetName.

Return Values

See Section 9.3, Target Service Return Values for more information.

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

0x00000000

Successful

0xFFFBFFFB

NWSMUT_OUT_OF_MEMORY

0xFFFBFFFC

NWSMUT_NO_MORE_NAMES

0xFFFBFFFD

NWSMUT_INVALID_PARAMETER

0xFFFBFFFF

NWSMUT_INVALID_HANDLE

0xFFFDFFB9

NWSMTS_UNSUPPORTED_FUNCTION

0xFFFDFFE0

NWSMTS_INVALID_NAME_SPACE_TYPE

0xFFFDFFE7

NWSMTS_INVALID_CONNECTION_HANDL

0xFFFEFFFE

NWSMDR_INVALID_PARAMETER

0xFFFEFFFF

NWSMDR_INVALID_CONNECTION

Remarks

NWSMTSParseDataSetName parses a data set name and returns the number of nodes and separators and a list of indexes to each node and separator (see Path Information).

NWSMTSParseDataSetName can be called when the engine needs to pass a path to the NWSM_DATA_SET_NAME_LIST or NWSM_SELECTION_LIST structure.