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

    List of all members.

    Public Member Functions

    HRESULT Item ([in] LONG nIndex,[out, retval] IWPFileInfo **ppFileInfo)
    HRESULT Count ([out, retval] LONG *nCount)
    HRESULT Add ([in] IWPFileInfo *pFileInfo)

    Detailed Description

    COM Wrapper for IWPFileList.

    This interface is implemented by WPFileList to wrap IWPFileList for Scripting clients to access a file list.

    Member Function Documentation

    HRESULT IWPFileList::Add (  [in] IWPFileInfo *  pFileInfo  ) 
     

    Add a file to the list.

    Parameters:
    pFileInfo IWPFileInfo.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_FAIL Can't find a trigger time event.
    Remarks:
    None.
    HRESULT IWPFileList::Count (  [out, retval] LONG *  nCount  ) 
     

    Get the number of files in the list.

    Parameters:
    nCount LONG count.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IWPFileList::Item (  [in] LONG  nIndex,
    [out, retval] IWPFileInfo **  ppFileInfo
    ) 
     

    Get a file from the list.

    Parameters:
    nIndex LONG index.
    ppFileInfo IWPFileInfo.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_FAIL Can't find a trigger time event.
    Remarks:
    None.