Share via

IFPCArray3::GetActivityStatistics method

  • Article

Applies to: desktop apps only

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

Syntax

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

FPCArray.GetActivityStatistics( _
  ByVal PeriodType As FpcActivityStatisticsPeriodType, _
  ByVal PeriodType As FpcActivityStatisticsPeriodType, _
  ByVal PeriodStart As DATE, _
  ByVal PeriodStart As Date, _
  ByVal PeriodEnd As DATE, _
  ByVal PeriodEnd As DATE, _
  ByRef pVal As IFPCActivityStatistics _
) As FPCActivityStatistics

Parameters

  • PeriodType [in]

    C++

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

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

  • PeriodStart [in]

    C++

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

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

  • PeriodEnd [in]

    C++

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

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

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

Return value

C++

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.

VB

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

Minimum supported client

 Windows Vista

Minimum supported server

 Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

 Forefront Threat Management Gateway (TMG) 2010

IDL

 Msfpccom.idl

DLL

 Msfpccom.dll

See also

FPCArray

 

 

Build date: 7/12/2010