Menu
Extensibility Solutions
  • Plug-Ins
  • Tools
  • Filters
  • Scripts
    • Developer Documentation
  • OmniEngine Plugin API
  • OmniPeek Plugin API
  • OmniScript Reference
  • Peek COM API Reference
  • Decoder Language Reference
  • ProtoSpecs XML Guidelines
  • Peek Reporting Framework
  • Automation Primer
  • Plug-in Primer
    • Summarize a packet for display in a packet list. More...

    List of all members.

    Public Member Functions

    HRESULT SummarizePacket ([in] IPacket *pPacket,[out] BSTR *pbstrSummary,[in, out] OLE_COLOR *pColor,[in, out] enum PeekSummaryLayer *pLayer)

    Detailed Description

    Optional interface implemented by Distributed Analysis Modules and used by the Omnipeek console. This interface is exposed by a Distributed Analysis Module that needs to display information in the Summary column of the Omnipeek console's packet list.

    Member Function Documentation

    HRESULT ISummarizePacket::SummarizePacket (  [in] IPacket *  pPacket,
    [out] BSTR *  pbstrSummary,
    [in, out] OLE_COLOR *  pColor,
    [in, out] enum PeekSummaryLayer *  pLayer
    ) 
     

    Allow a Distributed Analysis Module to get a text message displayed in the Summary column of a packet list.

    Parameters:
    pPacket Pointer to an IPacket interface that allows the Distributed Analysis Module to get information about the packet.
    pbstrSummary Pointer to the text message to be displayed in the Summary column of the packet list.
    pColor Pointer to OLE_COLOR which allows the analysis module to specify the color to be used for the text message.
    pLayer Pointer to PeekSummaryLayer which allows the Distributed Analysis Module to specify which layer, if any, of the ISO OSI 7-layer model corresponds to the text message.
    Return values:
    S_OK Success
    E_FAIL Error
    E_OUTOFMEMORY Out of memory
    E_POINTER One of the pointers is invalid
    Remarks:
    This interface should not be implemented if the Distributed Analysis Module does not need to display summary information in the packet list. When multiple Distributed Analysis Modules want to display a message for the same packet, the PeekSummaryLayer information is used to determine which message is displayed. In this case, the console displays the information corresponding to the highest layer.