IFsrmReportJob::NamespaceRoots property

Retrieves or sets an array of local directory paths that will be scanned when the report job is run.

This property is read/write.

Syntax


HRESULT put_NamespaceRoots(
  [in]   SAFEARRAY(VARIANT) namespaceRoots
);

HRESULT get_NamespaceRoots(
  [out]  SAFEARRAY(VARIANT) namespaceRoots
);

Property value

Each entry is either a valid path on the server that contains no wildcards (static namespaces) or the value of a FolderUsage property defined on the server (also called dynamic namespaces). If providing FolderUsage properties, the format "[Folder Usage_MS=value]" must be used. The path is limited to 260 characters. Each element of the SAFEARRAY is a VARIANT of type VT_BSTR. Set the bstrVal member of the variant to the directory path.

Error codes

The method returns the following return values.

NameMeaning
S_OK

Success

E_INVALIDARG

Returned for the following reasons:

  • The array is empty.
  • One or more of the variants are not a string.

Remarks

All subdirectories under the specified path are also scanned (recursively).

If you schedule this job, specify the same namespaces when calling the IFsrmReportScheduler::CreateScheduleTask method.

This property calls the IFsrmReportScheduler::VerifyNamespaces method to validate the paths. For validation details, see the Remarks section of VerifyNamespaces.

Note that FSRM supports only NTFS file systems—you cannot specify paths on ReFS, FAT, FAT32, UDF, or other non-NTFS file system.

Examples

For an example, see Defining a Report Job.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmReports.h

DLL

SrmSvc.dll

IID

IID_IFsrmReportJob is defined as 38e87280-715c-4c7d-a280-ea1651a19fef

See also

IFsrmReportJob

 

 

Show:
© 2014 Microsoft