Share via


GetDiagnosticLoggingStatus Method of the IFPCServer4 Interface

The GetDiagnosticLoggingStatus method retrieves information about the status of diagnostic logging on the server.

C++

Syntax

HRESULT GetDiagnosticLoggingStatus(
  [out]  BOOL* pfStarted,
  [out]  DWORD* pdwNumberOfRecords,
  [out]  DWORD* pdwComponentId
);

Parameters

  • pfStarted
    Required. Pointer to a BOOL value that on return indicates whether diagnostic logging is already running.

  • pdwNumberOfRecords
    Required. Pointer to a DWORD that on return indicates the number of currently available diagnostic logging records.

  • pdwComponentId
    Required. Pointer to a DWORD that on return indicates which logging components are on and which are off. This is deprecated in Forefront TMG, since all components are always running and cannot be turned on or off.

Return Value

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

Visual Basic

Syntax

Sub GetDiagnosticLoggingStatus( _
  ByRef pfStarted As Boolean, _
  ByRef pdwNumberOfRecords As Long, _
  ByRef pdwComponentId As Long _
)

Parameters

  • pfStarted
    Required. Reference to a Boolean value that on return indicates whether diagnostic logging is already running.

  • pdwNumberOfRecords
    Required. Reference to a 32-bit integer that on return indicates the number of currently available diagnostic logging records.

  • pdwComponentId
    Required. Reference to a 32-bit integer that on return indicates which logging components are on and which are off. This is deprecated in Forefront TMG, since all components are always running and cannot be turned on or off.

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

FPCServer

Send comments about this topic to Microsoft

Build date: 6/30/2010