IFsrmFileManagementJob::NamespaceRoots property

[This property is supported for compatibility but it's recommended to use the FSRM WMI Classes to manage FSRM. Please see the MSFT_FSRMFileManagementJob class.]

An array of local directory paths that will be scanned when the file management job is run.

This property is read/write.

Syntax


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

HRESULT get_NamespaceRoots(
  [out]  SAFEARRAY(VARIANT) *pNamespaceRoots
);

Property value

An array of namespaces to scan.

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 any of the following reasons:

  • The maximum path length is exceeded.
  • The array is empty.
  • One or more of the variants are not a string.
FSRM_E_INVALID_PATH

At least one path violates the specification for a valid path for the namespaceRoots parameter.

FSRM_E_PATH_NOT_FOUND

At least one path was not found.

Remarks

All subdirectories under each 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.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

DLL

SrmSvc.dll

IID

IID_IFsrmFileManagementJob is defined as 0770687e-9f36-4d6f-8778-599d188461c9

See also

IFsrmFileManagementJob
MSFT_FSRMFileManagementJob

 

 

Show:
© 2014 Microsoft