3.2.4.2.48.44 AddNotification (Opnum 54)

  • Article

The AddNotification method adds a notification period to the file management job's list of notification periods.

 [id(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x04)] HRESULT AddNotification(
   [in] long days
 );

days: Contains the value of the notification period to add to the file management job.

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

Return value/code

Description

0x80045303

FSRM_E_ALREADY_EXISTS

The object already exists.

0x80070057

E_INVALIDARG

The days parameter is not a valid value; it is less than zero.

Upon receiving this message, the server MUST validate parameters:

  • Verify that the days parameter is greater than or equal to 0.

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

The server MUST perform the following steps in sequence:

  • If the file management job's list of notification periods contains a Notification period whose Notification Interval is equivalent to days, the server MUST return FSRM_E_ALREADY_EXISTS.

  • Create a new Notification period object, and set its members as follows:

    • Notification Interval: Set to the value of days.

    • Notification period.Notifications: Set to an empty list.

  • Add the new Notification period to the file management job's list of notification periods.