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 IPeekRemoteCaptureList. More...

    List of all members.

    Public Member Functions

    HRESULT Item (LONG nIndex,[out, retval] IPeekRemoteCaptureInfo **pItem)
    HRESULT _NewEnum ([out, retval] IUnknown **pNewEnum)
    HRESULT Count ([out, retval] LONG *nCount)
    HRESULT AddItem ([in] IPeekRemoteCaptureInfo *pCaptureItem)
    HRESULT RemoveAll (void)

    Detailed Description

    COM Wrapper for IPeekRemoteCaptureList.

    This interface is implemented by PeekRemoteCaptureList to wrap IPeekRemoteCaptureList for Scripting clients to a list of captures.

    Member Function Documentation

    HRESULT IPeekRemoteCaptureList::_NewEnum (  [out, retval] IUnknown **  pNewEnum  ) 
     

    NewEnum.

    Parameters:
    pNewEnum NewEnum.
    Return values:
    E_NOTIMPL Not implemented.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureList::AddItem (  [in] IPeekRemoteCaptureInfo *  pCaptureItem  ) 
     

    Add a capture.

    Parameters:
    pCaptureItem Capture.
    Return values:
    S_OK Success.
    E_FAIL Failure.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureList::Count (  [out, retval] LONG *  nCount  ) 
     

    Get the number of captures in the list.

    Parameters:
    nCount Count.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureList::Item (  LONG  nIndex,
    [out, retval] IPeekRemoteCaptureInfo **  pItem
    ) 
     

    Get the capture.

    Parameters:
    nIndex Index.
    pItem IPeekRemoteCaptureInfo.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid argument.
    Remarks:
    None.
    HRESULT IPeekRemoteCaptureList::RemoveAll (  void   ) 
     

    Remove all the captures from the list.

    Return values:
    S_OK Success.
    Remarks:
    None.