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
    • COM Wrapper for IPeekRemoteCaptureInfo. More...

    List of all members.

    Public Member Functions

    HRESULT ID ([out, retval] BSTR *strCount)
    HRESULT Name ([out, retval] BSTR *strName)
    HRESULT Status ([out, retval] enum PeekCaptureStatus *pStatus)
    HRESULT PacketsFiltered ([out, retval] ULONG *nPacketsFiltered)
    HRESULT Creator ([out, retval] BSTR *strCreator)
    HRESULT LastModifiedBy ([out, retval] BSTR *strLastModBy)
    HRESULT LastModification ([out, retval] BSTR *strLastModDate)
    HRESULT BufferAllocated ([out, retval] ULONG *nBuffAlloc)
    HRESULT BufferUsed ([out, retval] ULONG *nBuffUsed)
    HRESULT BufferFree ([out, retval] ULONG *nBuffFree)
    HRESULT PacketsTotal ([out, retval] ULONG *nPacketsTotal)
    HRESULT StartTime ([out, retval] ULONGLONG *nStartTime)
    HRESULT Duration ([out, retval] ULONG *nDuration)
    HRESULT GraphCount ([out, retval] ULONG *nGraphCount)
    HRESULT GraphsEnabled ([out, retval] VARIANT_BOOL *bGraphsEnabled)
    HRESULT Create ([in] BSTR strID,[in] BSTR strName,[in] enum PeekCaptureStatus nState,[in] ULONG nPacketsFiltered,[in] ULONG nPacketsTotal,[in] ULONG nBufferAllocated,[in] ULONG nBufferUsed,[in] ULONG nBufferFree,[in] ULONGLONG nDuration,[in] ULONGLONG nStartTime,[in] BSTR strCreator,[in] BSTR strLastModifiedBy,[in] BSTR strLastModification,[in] VARIANT_BOOL bGraphsEnabled,[in] ULONG nGraphCount)

    Detailed Description

    COM Wrapper for IPeekRemoteCaptureInfo.

    This interface is implemented by PeekRemoteCaptureInfo to wrap IPeekRemoteCaptureInfo for Scripting clients to a remote capture's properties.

    Member Function Documentation

    HRESULT IPeekRemoteCaptureInfo::BufferAllocated (  [out, retval] ULONG *  nBuffAlloc  ) 
     

    Get the capture's allocated buffer.

    Parameters:
    nBuffAlloc Buffer allocation.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::BufferFree (  [out, retval] ULONG *  nBuffFree  ) 
     

    Get the capture's free buffer.

    Parameters:
    nBuffFree Buffer free.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::BufferUsed (  [out, retval] ULONG *  nBuffUsed  ) 
     

    Get the capture's used buffer.

    Parameters:
    nBuffUsed Buffer used.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::Create (  [in] BSTR  strID,
    [in] BSTR  strName,
    [in] enum PeekCaptureStatus  nState,
    [in] ULONG  nPacketsFiltered,
    [in] ULONG  nPacketsTotal,
    [in] ULONG  nBufferAllocated,
    [in] ULONG  nBufferUsed,
    [in] ULONG  nBufferFree,
    [in] ULONGLONG  nDuration,
    [in] ULONGLONG  nStartTime,
    [in] BSTR  strCreator,
    [in] BSTR  strLastModifiedBy,
    [in] BSTR  strLastModification,
    [in] VARIANT_BOOL  bGraphsEnabled,
    [in] ULONG  nGraphCount
    ) 
     

    Create a graph.

    Parameters:
    strID ID.
    strName Name.
    nState Status.
    nPacketsFiltered Number of filtered packets.
    nPacketsTotal Number of total packets.
    nBufferAllocated Amount of allocated buffer.
    nBufferUsed Amount of used buffer.
    nBufferFree Amount of free buffer.
    nDuration Duration.
    nStartTime Start time.
    strCreator Creator string.
    strLastModifiedBy User that last modified.
    strLastModification Last modification time.
    bGraphsEnabled Boolean of enabled graphs.
    nGraphCount Number of graphs.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::Creator (  [out, retval] BSTR *  strCreator  ) 
     

    Get the capture's creator.

    Parameters:
    strCreator Creator.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::Duration (  [out, retval] ULONG *  nDuration  ) 
     

    Get the capture's duration.

    Parameters:
    nDuration Duration.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::GraphCount (  [out, retval] ULONG *  nGraphCount  ) 
     

    Get the capture's graph count.

    Parameters:
    nGraphCount Graph count.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::GraphsEnabled (  [out, retval] VARIANT_BOOL *  bGraphsEnabled  ) 
     

    Get the boolean for graphs enabled.

    Parameters:
    bGraphsEnabled Boolean of enabled graphs.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::ID (  [out, retval] BSTR *  strCount  ) 
     

    Get the capture's ID.

    Parameters:
    strCount ID.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::LastModification (  [out, retval] BSTR *  strLastModDate  ) 
     

    Get the last modification date of the capture.

    Parameters:
    strLastModDate Last modification date.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::LastModifiedBy (  [out, retval] BSTR *  strLastModBy  ) 
     

    Get the user who last modified the capture.

    Parameters:
    strLastModBy Last modified by user.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::Name (  [out, retval] BSTR *  strName  ) 
     

    Get the capture's name.

    Parameters:
    strName Name.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::PacketsFiltered (  [out, retval] ULONG *  nPacketsFiltered  ) 
     

    Get the number of filtered packets.

    Parameters:
    nPacketsFiltered Filtered packets.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::PacketsTotal (  [out, retval] ULONG *  nPacketsTotal  ) 
     

    Get the capture's total number of packets.

    Parameters:
    nPacketsTotal Total packets.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::StartTime (  [out, retval] ULONGLONG *  nStartTime  ) 
     

    Get the capture's start time.

    Parameters:
    nStartTime Start time.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureInfo::Status (  [out, retval] enum PeekCaptureStatus *  pStatus  ) 
     

    Get the capture's capture status.

    Parameters:
    pStatus Capture status.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.