Contains information about one data set.
typedef struct
{
UINT16 bufferSize;
UINT16 scanInformationSize;
UINT32 attributes;
UINT32 creatorID;
UINT32 creatorNameSpaceNumber;
UINT32 primaryDataStreamSize;
UINT32 totalStreamsDataSize;
UINT8 modifiedFlag;
UINT8 deletedFlag;
UINT8 parentFlag;
UINT8 reserved[5];
UINT32 accessDateAndTime;
UINT32 createDateAndTime;
UINT32 modifiedDateAndTime;
UINT32 archivedDateAndTime;
UINT16 otherInformationSize;
UINT8 otherInformation[otherInformationSize];
} NWSM_SCAN_INFORMATION;
Specifies the actual buffer size allocated for NWSM_SCAN_INFORMATION.
Specifies the total memory used by NWSM_SCAN_INFORMATION (excluding bufferSize).
Specifies the data set's attributes.
Specifies the ID of the entity who created the data set.
Specifies the number of the name space that created the data set.
Specifies the size of the primary data stream (not the size of the data set).
Specifies the total number of 4 KB blocks used to contain all of the data set's data streams (not the data set's size).
Specifies if the data set was modified since the last backup:
Specifies if the data set was deleted:
Specifies if the data set is a parent:
Is reserved for future use.
Specifies the data set's last accessed date and time in DOS-packed format.
Specifies the data set's created date and time in DOS-packed format.
Specifies the data set's last modified date and time in DOS-packed format.
Specifies the data set's last archived date and time in DOS-packed format.
Specifies the size of otherInformation.
Is reserved for future use to specify TSA developer-specific information.
The information returned by NWSM_SCAN_INFORMATION depends upon the settings of NWSM_SCAN_CONTROL, NWSM_SELECTION_LIST, and the options supported by the TSA (see Unsupported Backup Options). This information may be used for backup logs and determining if the data exists before restoring it.
Not all TSAs support all the fields of NWSM_SCAN_INFORMATION. All unsupported fields are zeroed out by the TSA. NWSM_SCAN_INFORMATION and NWSM_DATA_SET_NAME_LIST represents the only information available to the engine about the data set.
NOTE:For users of SIDF, the scan control information and the data set’s name information are known as the data set information.
The values that can be set to attributes is listed in the following table.
creatorID is not generic and is defined by the TSA. For NetWare, it is the bindery ID.
creatorNameSpaceNumber has a corresponding name space name string that is returned by NWSMTSListSupportedNameSpaces. This number is always returned even if the creator name space type was not requested by field returnNameSpaceType of NWSM_SCAN_CONTROL.
Call NWSMTSGetUnsupportedOptions to see if the TSA supports accessDateAndTime, createDateAndTime, modifiedDateAndTime, and archivedDateAndTime.
The NSS file system supports files of sizes more than 4 GB. The primaryDataStreamSize returns the first double word (low order four bytes) of the file size. The file system TSA returns the second double word as part of the otherInformation while setting the otherInformationSize to 4.
Different TSAs may have meta data regarding data sets that do not fit into the existing definition of the scan information structure. Such information is returned as extensions in the otherInformation field. The otherInformationSize is set to the number of bytes of extension information that is returned in this case. This size and the otherInformation buffer can be used with the extension APIs to process this additional meta data. See Section 6.3, Extension Functions. The extensions and their fields are detailed in Section 5.7, Extensions.
NOTE:As the otherInformation field is already extended to contain the second double word to represent QUAD file sizes, extensions are appended after the first double word when present. Use otherInformationSize after subtracting the size of a double word to ensure that there are extensions encoded in otherInformation.