IFPCWebUsageReports::UsersReportSortOrder property

Article
08/27/2012

Applies to: desktop apps only

The UsersReportSortOrder property gets or sets a value from the FpcTopUsersReportSortOrder enumerated type that specifies how the information in the top Web users section of a Web usage report is to be sorted. The top Web users section of a Web usage report contains information about the most active users. The report can be sorted according to the number of requests sent by each user or the number of bytes transferred for each user.

Note This property and the parent object are deprecated in Forefront TMG 2010.

This property is read/write.

Syntax

HRESULT put_UsersReportSortOrder(
  FpcTopUsersReportSortOrder UsersSortOrder
);

HRESULT get_UsersReportSortOrder(
  FpcTopUsersReportSortOrder *pUsersSortOrder
);

Property UsersReportSortOrder( _
  ByVal UsersSortOrder As FpcTopUsersReportSortOrder, _
  ByVal pUsersSortOrder As FpcTopUsersReportSortOrder _
) As FpcTopUsersReportSortOrder

Property value

Value from the FpcTopUsersReportSortOrder enumerated type that specifies how the information in the top Web users section of a Web usage report is to be sorted.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write. Its default value is fpcTopUsersTotalBytes, which indicates that the information is to be sorted by the total number of bytes for each user.

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