Share via

SetAsOncePerMonthReportJob Method of the IFPCReportJob Interface

  • Article

The SetAsOncePerMonthReportJob method sets the report job to run once a month, on a specified day of the month, starting from a specified date.

C++

Syntax

HRESULT SetAsOncePerMonthReportJob(
  [in]            long DayOfMonth,
  [in]            FpcReportJobPeriodType PeriodType,
  [in, optional]  DATE StartDate
);

Parameters

  • DayOfMonth
    A 32-bit integer that specifies the day of the month on which the report will be generated.

  • PeriodType
    Value from the FpcReportJobPeriodType enumerated type that specifies the type of period (such as a day, a week, or a month) that the daily report will cover. The value fpcReportJobPeriodCustom, which is reserved for report jobs that run once, is not allowed.

  • StartDate
    Date value indicating the day on which the report will start being generated. The default value is the day on which the report job was created.

Return Value

This method returns S_OK if the call is successful; otherwise, it returns an error code.

Visual Basic

Syntax

Sub SetAsOncePerMonthReportJob( _
  ByVal DayOfMonth As Long, _
  ByVal PeriodType As FpcReportJobPeriodType, _
  [ ByVal StartDate As Date ] _
)

Parameters

  • DayOfMonth
    A 32-bit integer that specifies the day of the month on which the report will be generated.

  • PeriodType
    Value from the FpcReportJobPeriodType enumerated type that specifies the type of period (such as a day, a week, or a month) that the daily report will cover. The value fpcReportJobPeriodCustom, which is reserved for report jobs that run once, is not allowed.

  • StartDate
    Date value indicating the day on which the report will start being generated. The default value is the day on which the report job was created.

Return Value

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Requirements

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.
DLL

Requires Msfpccom.dll.

See Also

FPCReportJob

Send comments about this topic to Microsoft

Build date: 6/30/2010