GetDiagnosticLoggingStatus Method of the IFPCServer4 Interface

The GetDiagnosticLoggingStatus method returns Diagnostic Logging Status.

[C++]

Syntax

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

Parameters

pfStarted

Pointer to a BOOL value that on return indicates whether the method is already running.

pdwNumberOfRecords

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

pdwComponentId

Pointer to a DWORD that on return indicates what logging components are on and what are off. This is deprecated, since all components in Forefront TMG 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

Function GetDiagnosticLoggingStatus( _
  ByRef pfStarted As Boolean, _
  ByRef pdwNumberOfRecords As DWORD, _
  ByRef pdwComponentId As DWORD _
) As BooleanDWORDDWORD

Parameters

pfStarted

Reference to a Boolean value that on return indicates if the method is already running.

pdwNumberOfRecords

Reference to a DWORD that on return indicates the number of currently available diagnostic logging records.

pdwComponentId

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

Return Value

If the call is unsuccessful, 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

FPCServer


Send comments about this topic to Microsoft

Build date: 11/30/2009

 

© 2008 Microsoft Corporation. All rights reserved.