IFsrmFileManagementJob::CreateNotificationAction method

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

Creates a notification action and associates it with the notification value.

Syntax


HRESULT CreateNotificationAction(
  [in]  long           days,
  [in]  FsrmActionType actionType,
  [out] IFsrmAction    **action
);

Parameters

days [in]

The notification value to associate with the action.

actionType [in]

The action to perform when the notification period is reached, enumerated by the FsrmActionType enumeration.

Note  The FsrmActionType_Report type is not valid for this method.
 

FsrmActionType_EventLog (1)

Log an event to the Application event log.

FsrmActionType_Email (2)

Send an email message.

FsrmActionType_Command (3)

Execute a command or script.

action [out]

An IFsrmAction interface of the newly created action. Query the interface for the action interface that you specified in the actionType parameter. For example, if the action type is FsrmActionType_Command, query the interface for the IFsrmActionCommand interface.

Return value

The method returns the following return values.

S_OK

Success

FSRM_E_ALREADY_EXISTS

An action of the specified type already exists for the notification value.

FSRM_E_NOT_FOUND

The specified notification value was not found.

FSRM_E_NOT_SUPPORTED

The actiontype parameter is not valid.

Remarks

You can specify up to three unique actions for each notification value.

The action is deleted when the notification is deleted.

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
IFsrmFileManagementJob::EnumNotificationActions
MSFT_FSRMFileManagementJob

 

 

Show: