NWSMTSOpenDataSetForBackup

Opens the data set referenced by the sequence value that returned the scanning functions.

Syntax

  #include <smstsapi.h> 
   
  CCODE NWSMTSOpenDataSetForBackup (
     UINT32   connection, 
     UINT32   sequence, 
     UINT32   mode, 
     UINT32 *dataSetHandle);
  

Parameters

connection

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

sequence

(IN) Specifies the sequence number returned by NWSMTSScanDataSetBegin or NWSMTSScanNextDataSet.

mode

(IN) Specifies the generic and TSA-specific open mode to apply to the data set (see Open Modes for possible values).

dataSetHandle

(OUT) Points to a handle used to subsequently call NWSMTSReadDataSet or NWSMTSCloseDataSet.

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

0xFFFDFFAF

NWSMTS_CLUSTER_TARGET_DOES_NOT_EXIST

0xFFFDFFB5

NWSMTS_WRITE_ERROR

0xFFFDFFB9

NWSMTS_UNSUPPORTED_FUNCTION

0xFFFDFFC9

NWSMTS_OUT_OF_MEMORY

0xFFFDFFCC

NWSMTS_OPEN_ERROR

0xFFFDFFCD

NWSMTS_OPEN_DATA_STREAM_ERR

0xFFFDFFD8

NWSMTS_INVALID_SEQUENCE_NUMBER

0xFFFDFFE7

NWSMTS_INVALID_CONNECTION_HANDL

0xFFFDFFF3

NWSMTS_DATA_SET_IS_OPEN

0xFFFDFFF5

NWSMTS_DATA_SET_IN_USE

0xFFFDFFF6

NWSMTS_DATA_SET_EXECUTE_ONLY

0xFFFDFFFB

NWSMTS_CLOSE_BINDERY_ERROR

0xFFFEFFFE

NWSMDR_INVALID_PARAMETER

0xFFFEFFFF

NWSMDR_INVALID_CONNECTION

Remarks

Before NWSMTSOpenDataSetForBackup is called, NWSMTSScanDataSetBegin must be called to initiate the scan.

The TSA must ensure that no attributes are altered on the Target Service during the backup session.

NWSMTSOpenDataSetForBackup prepares the Target Service data set to be backed up. To close the data set, call NWSMTSCloseDataSet.

To determine the existing TSA-specific open modes for a given TSA, call NWSMTSGetOpenModeOptionString.

See Also

NWSMTSCloseDataSet, NWSMTSScanDataSetBegin, NWSMTSScanNextDataSet