GetDiagnosticLogging Method of the IFPCServer4 Interface

The GetDiagnosticLogging method gets the diagnostic logging result.

[C++]

Syntax

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

Parameters

pdwStartIndex

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 the most recent diagnostic logging results should be retrieved.

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

pdwBufferSize

Pointer to a DWORD.

As an input parameter, indicates the maximum buffer size (in bytes) of diagnostic logging results to return with the method call. Must be in the [100, 100000] range (inclusive); otherwise, 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

Address of a pointer that on return points to a BYTE that stores diagnostic logging results. The memory is allocated with CoTaskMemAlloc; therefore it should be deleted with CoTaskMemFree.

Return Value

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

[Visual Basic]

Syntax

Function GetDiagnosticLogging( _
  ByRef pdwStartIndex As DWORD, _
  ByRef pdwBufferSize As DWORD, _
  ByRef pBuffer As BYTE _
) As DWORDDWORDBYTE

Parameters

pdwStartIndex

Reference 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 the most recent diagnostic logging results should be retrieved.

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

pdwBufferSize

Reference to a DWORD.

As an input parameter, indicates the maximum buffer size (in bytes) of diagnostic logging results to return with the method call. Must be in the [100, 100000] range (inclusive).

On return, the parameter stores the actual buffer size (in bytes) of the data referenced by pBuffer.

pBuffer

Reference to a BYTE that on return stores diagnostic logging results.

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.