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
    • Summary statistics snapshot. More...

    List of all members.

    Public Member Functions

    HRESULT Item ([in] LONG lIndex,[out, retval] GUID *pID)
    HRESULT Count ([out, retval] LONG *plCount)
    HRESULT Name ([out, retval] BSTR *pbstrName)
    HRESULT Name ([in] BSTR bstrName)
    HRESULT ID ([out, retval] GUID *pID)
    HRESULT ID ([in] GUID id)
    HRESULT AddItem ([in] GUID id,[in] GUID parent)
    HRESULT RemoveItem ([in] GUID id)
    HRESULT GetItemParent ([in] GUID id,[out] GUID *pID)
    HRESULT SetItemLabel ([in] GUID id,[in] BSTR bstrLabel)
    HRESULT GetItemLabel ([in] GUID id,[out] BSTR *pbstrLabel)
    HRESULT SetItemValue ([in] GUID id,[in] PeekSummaryStat *pValue)
    HRESULT GetItemValue ([in] GUID id,[out] PeekSummaryStat *pValue)

    Detailed Description

    This interface is implemented by the Omnił Engine and allows items to be added to the summary statistics display.

    Member Function Documentation

    HRESULT ISummaryStatsSnapshot::AddItem (  [in] GUID  id,
    [in] GUID  parent
    ) 
     

    Add a summary statistics item.

    Parameters:
    id Globally unique identifier of the item.
    parent Globally unique identifier of the parent of the item.
    Return values:
    S_OK Success
    E_FAIL Error
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::Count (  [out, retval] LONG *  plCount  ) 
     

    Get the count of summary statistics items.

    Parameters:
    plCount Pointer to a variable that receives the count of items.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::GetItemLabel (  [in] GUID  id,
    [out] BSTR *  pbstrLabel
    ) 
     

    Get the label for a summary statistics item.

    Parameters:
    id Globally unique identifier of the item.
    pbstrLabel Pointer to a variable that receives the BSTR containing the label.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::GetItemParent (  [in] GUID  id,
    [out] GUID *  pID
    ) 
     

    Get the parent ID for a summary statistics item.

    Parameters:
    id Globally unique identifier of the item.
    pID Pointer to a variable that receives the globally unique identifier of the parent of the item.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::GetItemValue (  [in] GUID  id,
    [out] PeekSummaryStat *  pValue
    ) 
     

    Get the value for a summary statistics item.

    Parameters:
    id Globally unique identifier of the item.
    pValue Pointer to a variable that receives the value.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::ID (  [in] GUID  id  ) 
     

    Set the summary statistics snapshot ID. Not normally used by a client.

    Parameters:
    id The globally unique identifier to assign to the snapshot.
    Return values:
    S_OK Success
    E_FAIL Error
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::ID (  [out, retval] GUID *  pID  ) 
     

    Get the summary statistics snapshot ID.

    Parameters:
    pID Pointer to a variable that receives the globally unique identifier assigned to the snapshot.
    Return values:
    S_OK Success
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::Item (  [in] LONG  lIndex,
    [out, retval] GUID *  pID
    ) 
     

    Get a summary statistics item by index.

    Parameters:
    lIndex Index of the item
    pID Pointer to a variable that receives the globally unique identifier assigned to the item.
    Return values:
    S_OK Success
    E_FAIL Error
    E_INVALIDARG The index is out of bounds.
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::Name (  [in] BSTR  bstrName  ) 
     

    Set the summary statistics snapshot name.

    Parameters:
    bstrName BSTR containing the name.
    Return values:
    S_OK Success
    E_FAIL Error
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::Name (  [out, retval] BSTR *  pbstrName  ) 
     

    Get the summary statistics snapshot name.

    Parameters:
    pbstrName Pointer to a variable that receives a BSTR containing the name.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::RemoveItem (  [in] GUID  id  ) 
     

    Remove a summary statistics item.

    Parameters:
    id Globally unique identifier of the item.
    Return values:
    S_OK Success
    E_FAIL Error
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::SetItemLabel (  [in] GUID  id,
    [in] BSTR  bstrLabel
    ) 
     

    Set the label for a summary statistics item.

    Parameters:
    id Globally unique identifier of the item.
    bstrLabel BSTR containing the label of the item.
    Return values:
    S_OK Success
    E_FAIL Error
    Remarks:
    None
    HRESULT ISummaryStatsSnapshot::SetItemValue (  [in] GUID  id,
    [in] PeekSummaryStat *  pValue
    ) 
     

    Set the value for a summary statistics item.

    Parameters:
    id Globally unique identifier of the item.
    pValue Pointer to the value.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None