3.2.4.2.48.48 EnumNotificationActions (Opnum 58)

The EnumNotificationActions method enumerates all the notifications for the specified notification period.

 [id(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x08)] HRESULT EnumNotificationActions(
   [in] long days,
   [out, retval] IFsrmCollection** actions
 );

days: The days parameter contains the notification period for which notifications are to be enumerated.

actions: Pointer to an IFsrmCollection interface pointer (section 3.2.4.2.1) that upon completion contains IFsrmAction interface pointers of all the notifications for the specified notification period. A caller MUST release the collection received when the caller is done with it. To get the specific action interface for the action, the caller MUST call QueryInterface for the interface corresponding to the action's action type.

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

Return value/code

Description

0x80045301

FSRM_E_NOT_FOUND

The specified notification could not be found.

0x80070057

E_INVALIDARG

The actions parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

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

  • Verify that actions is not NULL.

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

The server MUST perform the following steps in sequence or return a nonzero error code as follows:

  • Find the Notification period, if any, in the file management job's list of notification periods whose Notification Interval is equivalent to days. For the remainder of these steps, this will be referred to as the affected notification period.

  • If there is no affected notification period, the server MUST return FSRM_E_NOT_FOUND.

  • The server MUST create a new IFsrmCollection object and populate it with any notifications from the affected notification period's Notification period.Notifications property.

  • The server MUST assign the new IFsrmCollection object to actions.