NWSMTSGetNameSpaceTypeInfo

Returns the path node order and separators for the specified name space.

Syntax

  #include <smstsapi.h> 
   
  CCODE NWSMTSGetNameSpaceTypeInfo (
     UINT32          connection, 
     UINT32          nameSpaceType, 
     NWBOOLEAN      *reverseOrder, 
     STRING_BUFFER **firstSeparator, 
     STRING_BUFFER **secondSeparator);
  

Parameters

connection

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

nameSpaceType

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

reverseOrder

(OUT) Points to a flag indicating if reverse order should be used:

  • TRUE Subordinates are on the left
  • FALSE Subordinates are on the right
firstSeparator

(OUT) Points to the first separator string.

secondSeparator

(OUT) Points to the second separator string.

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

0xFFFDFFB9

NWSMTS_UNSUPPORTED_FUNCTION

0xFFFDFFC9

NWSMTS_OUT_OF_MEMORY

0xFFFDFFE0

NWSMTS_INVALID_NAME_SPACE_TYPE

0xFFFDFFE7

NWSMTS_INVALID_CONNECTION_HANDL

0xFFFEFFFE

NWSMDR_INVALID_PARAMETER

0xFFFEFFFF

NWSMDR_INVALID_CONNECTION

Remarks

Before NWSMTSGetNameSpaceTypeInfo is called, the engine must be connected to a TSA and Target Service.

The information returned by NWSMTSGetNameSpaceTypeInfo can be used to build lists for NWSM_DATA_SET_NAME_LIST and NWSM_SELECTION_LIST.

If the path order is reversed, the subordinates are to the left of their superiors. For example, "Employee.Department.Company.Country" is a reversed path.

firstSeparator and secondSeparator must point to a valid non-autovariable structure or NULL. NWSMTSGetNameSpaceTypeInfo allocates memory when a NULL is passed, or reallocates memory if the structure does not have enough space. To free the memory for the separators, call NWSMFreeString (see Storage Management Services Library).

Example

See NWSMTSListTSResources for an example.