IFsrmFileManagementJob::AddNotification method (fsrmreports.h)

Article
10/13/2021

[This method is supported for compatibility but it's recommended to use the FSRM WMI Classes to manage FSRM. Please see the MSFT_FSRMFMJNotification::CreateFMJNotification method.]

Adds a new notification value (period) to the file management job's list of notifications.

Syntax

HRESULT AddNotification(
  [in] long days
);

Parameters

[in] days

A unique notification value to add. The value cannot be less than zero.

Return value

The method returns the following return values.

Remarks

The days parameter specifies the number of days before the file is to expire. If the appropriate conditions set in the job are met, notification will be sent to the user to let them know that the file is about to expire. FSRM uses the actions associated with the notification value to determine how the user is notified.

Notification occurs when the job runs and the following conditions are met:

Today is the day when notification should occur.
The day when notification should occur is before the next scheduled run time.

Note that it is possible for the user to receive duplicate notifications. For example, the user can receive duplicate notifications if the job is run manually after the notification is sent but on or before the day when the notification should occur.

The FromDate determines when the notification window begins. The following properties determine when the file is to expire:

DaysSinceFileCreated
DaysSinceFileLastAccessed
DaysSinceFileLastModified
PropertyConditions (use the CreatePropertyCondition method to create the property condition)
FileNamePattern

To associate an action with the notification value, call the IFsrmFileManagementJob::CreateNotificationAction method.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2
Target Platform	Windows
Header	fsrmreports.h
DLL	SrmSvc.dll