Share via

GetActivityStatistics Method of the IFPCArray3 Interface

  • Article

The GetActivityStatistics method gets an FPCActivityStatistics collection that contains the activity counter entries for the array during a specified period of time.

C++

Syntax

HRESULT GetActivityStatistics(
  [in]   FpcActivityStatisticsPeriodType PeriodType,
  [in]   DATE PeriodStart,
  [in]   DATE PeriodEnd,
  [out]  IFPCActivityStatistics** pVal
);

Parameters

  • PeriodType
    Required. Value from the FpcActivityStatisticsPeriodType enumerated type that specifies whether daily or monthly activity statistics will be retrieved.

  • PeriodStart
    Required. DATE value that specifies the date and time in Coordinated Universal Time (UTC) when retreival of the activity statistics will start.

  • PeriodEnd
    Required. DATE value that specifies the date and time in Coordinated Universal Time (UTC) when retreival of the activity statistics will end.

  • pVal
    Address of an interface pointer that on return points to the IFPCActivityStatistics interface that represents the collection of activity statistics retrieved.

Return Value

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

Visual Basic

Syntax

Function GetActivityStatistics( _
  ByVal PeriodType As FpcActivityStatisticsPeriodType, _
  ByVal PeriodStart As Date, _
  ByVal PeriodEnd As DATE _
) As FPCActivityStatistics

Parameters

  • PeriodType
    Required. Value from the FpcActivityStatisticsPeriodType enumerated type that specifies whether daily or monthly activity statistics will be retrieved.

  • PeriodStart
    Required. Date value that specifies the date and time in Coordinated Universal Time (UTC) when retreival of the activity statistics will start.

  • PeriodEnd
    Required. Date value that specifies the date and time in Coordinated Universal Time (UTC) when retreival of the activity statistics will end.

Return Value

This method returns a reference to an FPCActivityStatistics collection if successful. Otherwise, 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

FPCArray

Send comments about this topic to Microsoft

Build date: 6/30/2010