NWSMTSScanDataSetEnd

Stops the scan started by NWSMTSScanDataSetBegin.

Syntax

  #include <smstsapi.h> 
   
  CCODE NWSMTSScanDataSetEnd 
     UINT32                        connection, 
     UINT32                       *sequence, 
     NWSM_SCAN_INFORMATION   **scanInformation, 
     NWSM_DATA_SET_NAME_LIST **dataSetNames);

Parameters

connection

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

sequence

(IN/OUT) Inputs a pointer to the sequence value returned by NWSMTSScanDataSetBegin or NWSMTSScanNextDataSet. Outputs zero.

scanInformation

(IN/OUT) Inputs a pointer to the memory to be freed. Outputs NULL.

dataSetNames

(IN/OUT) Inputs a pointer to the memory to be freed. Outputs NULL.

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

0xFFFDFFD8

NWSMTS_INVALID_SEQUENCE_NUMBER

0xFFFDFFE7

NWSMTS_INVALID_CONNECTION_HANDL

0xFFFDFFF3

NWSMTS_DATA_SET_IS_OPEN

0xFFFEFFFE

NWSMDR_INVALID_PARAMETER

0xFFFEFFFF

NWSMDR_INVALID_CONNECTION

Remarks

Before NWSMTSScanDataSetEnd is called, NWSMTSScanDataSetBegin must be called to initiated a scan.

NWSMTSScanDataSetEnd stops a scan prematurely. Do not call NWSMTSScanDataSetEnd if NWSMTSScanDataSetBegin or NWSMTSScanNextDataSet returns an error.

See Also

NWSMTSReleaseTargetService, NWSMReleaseTSA

Example

See the example for NWSMTSScanDataSetBegin.