IFsrmFileManagementJob::ExpirationDirectory 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.]

The root directory that will contain the expired files.

This property is read/write.

Syntax


HRESULT put_ExpirationDirectory(
  [in]  BSTR expirationDirectory
);

HRESULT get_ExpirationDirectory(
  [out] BSTR *pExpirationDirectory
);

Property value

Contains the local directory path to which files that match all the file management job's conditions will be moved to when the file management job is run. The total path string length cannot exceed 148 characters and must refer to a directory on an NTFS volume where the current process has write permission.

Error codes

The method returns the following return values.

S_OK

Success

E_INVALIDARG

Returned for any of the following reasons:

  • The path string is too long.
  • The path does not refer to a location on an NTFS volume.
  • The path is not writable.

Remarks

FSRM moves the files that meet all of the file management job's conditions to this directory when the job is run, therefore the running process must have write permission. The directory must also be located on an NTFS volume.

FSRM maintains the file's current directory structure in the expired directory so you can determine its previous location. For example, if FSRM expired the file, "C:\TestExpired\Test1.txt", the expired root directory would contain:

"FsrmServer(FQDN)\JobName_TimeStamp\C$\TestExpired\Test1.txt"

The expired file's ACLs are maintained with the file.

If the expiration directory does not exist, FSRM creates the directory (with administrator access rights only).

Do not specify an expiration directory that is in the NamespaceRoots path.

Specify only if OperationType is FsrmFileManagementType_Expiration.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Header

FsrmReports.h

DLL

SrmSvc.dll

IID

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

See also

IFsrmFileManagementJob
MSFT_FSRMFileManagementJob

 

 

Show: