IFsrmFileManagementJob::CreateCustomAction 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 custom action object.

Syntax


HRESULT CreateCustomAction(
  [out]  IFsrmActionCommand **customAction
);

Parameters

customAction [out]

An IFsrmActionCommand interface that you can use to specify a custom action to perform if the job's property conditions are met.

Return value

The method returns the following return values. Implementers should return an HRESULT error code for any other errors.

Return codeDescription
S_OK

Success.

FSRM_E_ALREADY_EXISTS

A custom action already exists.

 

Remarks

To get the custom action, access the CustomAction property.

Create a custom action only if the job's OperationType is set to FsrmFileManagementType_Custom.

For a list of macros supported, perform a "get" operation on the IFsrmFileManagementJobManager::ActionVariables and IFsrmFileManagementJobManager::ActionVariableDescriptions properties.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

DLL

SrmSvc.dll

IID

IID_IFsrmFileManagementJob is defined as 0770687e-9f36-4d6f-8778-599d188461c9

See also

IFsrmActionCommand::Arguments
IFsrmFileManagementJob
MSFT_FSRMFileManagementJob

 

 

Show:
© 2014 Microsoft