GetActivityStatistics Method of the IFPCArray3 Interface

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:

[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 Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCArray


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.