3.2.4.2.11.13 GetActionRunLimitInterval (Opnum 19)

The GetActionRunLimitInterval method returns the Run limit interval for actions that are configured to use the general setting's Run limit interval.

 [id(FSRM_DISPID_SETTING | 0x03)] HRESULT GetActionRunLimitInterval(
   [in] FsrmActionType actionType,
   [out, retval] long* delayTimeMinutes
 );

actionType: Contains the action type to return the Run limit interval for.

delayTimeMinutes: Pointer to a variable that upon completion contains the Run limit interval for the specified action type.

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

Return value/code

Description

0x80070057

E_INVALIDARG

This code is returned for the following reasons:

  • The actionType parameter is not a valid type. If actionType is FsrmActionType_Unknown, the parameter MUST be considered an invalid value.

  • The delayTimeMinutes parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that actionType is a valid FsrmActionType (section 2.2.1.2.9) value. If the actionType is FsrmActionType_Unknown, the parameter MUST be considered an invalid value.

  • Verify that delayTimeMinutes is not NULL.

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

Upon successful validation of parameters, the server MUST perform the following actions or return a nonzero error code.

  • Verify that Run limit interval is present for actionType.<55>

The server MUST set delayTimeMinutes to the general setting's Run limit interval for the specified action type or return a nonzero error code.