IFsrmFileScreenBase::CreateAction method

Creates an action for this file screen object. The action is triggered when a file violates the file screen.

Syntax


HRESULT CreateAction(
  [in]  FsrmActionType actionType,
  [out] IFsrmAction    **action
);

Parameters

actionType [in]

The type of action to create. For possible values, see the FsrmActionType enumeration.

action [out]

An IFsrmAction interface to the newly created action. Query the interface for the specific action specified. For example, if actionType is FsrmActionType_Command, query action for the IFsrmActionCommand interface.

Return value

The method returns the following return values.

S_OK

Success.

E_INVALIDARG

The action parameter is NULL or the actionType parameter contains a type that is not valid.

FSRM_E_ALREADY_EXISTS

An action of the specified type already exists for this file screen.

Remarks

You can specify up to four unique actions for each file screen.

The action is deleted if the file screen is deleted.

Examples

For an example, see Performing Actions Based on File Screen Violations.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmScreen.h (include FsrmScreen.h or FsrmTlb.h)

IDL

FsrmScreen.idl

DLL

SrmSvc.dll

IID

IID_IFsrmFileScreenBase is defined as f3637e80-5b22-4a2b-a637-bbb642b41cfc

See also

IFsrmFileScreenBase

 

 

Show: