Compares a data set name against its internal selection list (set up by NWSMTSSetRestoreOptions) and indicates if the data set is included or not.
#include <smstsapi.h>
CCODE NWSMTSIsDataSetExcluded (
UINT32 connection,
NWBOOLEAN isParent,
NWSM_DATA_SET_NAME_LIST *dataSetName);
(IN) Specifies the connection information returned by NWSMTSConnectToTargetService or NWSMTSConnectToTargetServicEx.
(IN) Specifies a flag returned in NWSM_SCAN_INFORMATION indicating whether the data set is a parent:
(IN) Points to the data set’s fully qualified path.
See Section 9.3, Target Service Return Values for more information.
The following table lists the return values associated with the function.
To build dataSetName the “Data Set Name Functions” listed in Storage Management Services Library can be used.
Before NWSMTSIsDataSetExcluded is called, NWSMTSSetRestoreOptions must be called with dontCheckSelectionList set to TRUE.
NWSMTSIsDataSetExcluded uses the selection list from NWSMTSSetRestoreOptions to decide if dataSetName is excluded. NWSMTSIsDataSetExcluded is used to help speed up the restore process and does not have to be used (see Set the Restore Options).
dataSetName can be taken from a database or from a transfer buffer received from SMS DI. If the data set name is not already in an NWSMTS_DATA_SET_NAME_LIST structure, the “Data Set Name Functions” shown in Storage Management Services Utilities Library can be used to insert it into the structure. The data for this list can only come from NWSMTSScanDataSetBegin or NWSMTSScanNextDataSet. From this list, the only element that uses the name space supported by the Target Service will be compared against the internal selection list.
NOTE:The bindery must be explicitly included in the restore session or it will not be restored.
If the data set name was not produced by the TSA, the engine must be aware of the two following precautions:
If the engine builds the data set name list, the engine must ensure that the data set name format and case format follows the intended name space's specifications.
Parent data set names may need an end separator if the name space requires it.
NOTE:NWSMTSIsDataSetExcluded will not correct improperly-formatted data set names.