GetDiagnosticLogging Method of the IFPCServer4 Interface

The GetDiagnosticLogging method retrieves diagnostic logging results on the server.

Syntax

HRESULT GetDiagnosticLogging(
  [in, out]  DWORD* pdwStartIndex,
  [in, out]  DWORD* pdwBufferSize,
  [out]      BYTE** ppBuffer
);

Parameters

  • pdwStartIndex
    Required. Pointer to a DWORD.

    As an input paramter, a positive value represents the index of the first diagnostic logging result to retrieve. A value of 0 indicates that only the most recent diagnostic logging result should be retrieved.

    On return, the parameter stores the index of the next record not retrieved by the method call.

  • pdwBufferSize
    Required. Pointer to a DWORD.

    As an input parameter, it indicates the maximum buffer size (in bytes) of diagnostic logging results to return in the method call. The value must be in the [100, 100000] range (inclusive); otherwise, the E_INVALIDARG error code will be returned.

    On return, the parameter stores the actual buffer size (in bytes) of the data pointed at by ppBuffer.

  • ppBuffer
    Required. Address of a pointer that on return points to the BYTE at the beginning of the block of memory where the diagnostic logging results are stored. The memory is allocated by CoTaskMemAlloc; therefore it must be deleted by using CoTaskMemFree.

Return Value

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • E_INVALIDARG, indicating that the buffer size supplied in the pdwBufferSize parameter was not in the [100, 100000] range (inclusive). In this case, the [out] parameters returned do not contain valid data.

Remarks

This method cannot be used in Microsoft Visual Basic Scripting Edition (VBScript).

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