3.2.4.2.48.11 ExpirationDirectory (put) (Opnum 21)

  • Article

The ExpirationDirectory (put) method sets the expiration directory the file management job.

 [propput, id(FSRM_PROPERTY(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x05))] HRESULT ExpirationDirectory(
   [in] BSTR expirationDirectory
 );

expirationDirectory: Contains the expiration directory where files matching all the file management job's conditions will be moved to when the file management job is run.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80070057

E_INVALIDARG

This code is returned for the following reasons:

  • The expirationDirectory parameter is not a valid value; the path is not writeable.

  • The expirationDirectory parameter exceeds the maximum length of 148 characters.

  • The expirationDirectory path does not refer to a location on an NTFS volume.

Upon receiving this message, the server MUST validate parameters:

  • Verify that expirationDirectory contains a valid local directory that the File Server Resource Manager service can write to.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

 The server MUST set the expiration directory for the file management job to expirationDirectory.