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

    List of all members.

    Public Member Functions

    HRESULT Name ([out, retval] BSTR *pName)
    HRESULT Name ([in] BSTR *pName)
    HRESULT FileVersion ([out, retval] BSTR *pFileVer)
    HRESULT FileVersion ([in] BSTR *pFileVer)
    HRESULT ProductVersion ([out, retval] BSTR *pProdVer)
    HRESULT ProductVersion ([in] BSTR *pProdVer)
    HRESULT Captures ([out, retval] BSTR *pCaptures)
    HRESULT Captures ([in] BSTR *pCaptures)

    Detailed Description

    COM Wrapper for IEngineStatus.

    This interface is implemented by EngineStatus to wrap IEngineStatus for Scripting clients to access properties of an engine.

    Member Function Documentation

    HRESULT IEngineStatus::Captures (  [in] BSTR *  pCaptures  ) 
     

    Put the number of captures on the engine.

    Parameters:
    pCaptures Number of captures.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IEngineStatus::Captures (  [out, retval] BSTR *  pCaptures  ) 
     

    Get the number of captures on the engine.

    Parameters:
    pCaptures Number of captures.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IEngineStatus::FileVersion (  [in] BSTR *  pFileVer  ) 
     

    Put the engine's file version.

    Parameters:
    pFileVer File version string.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IEngineStatus::FileVersion (  [out, retval] BSTR *  pFileVer  ) 
     

    Get the engine's file version.

    Parameters:
    pFileVer File version string.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IEngineStatus::Name (  [in] BSTR *  pName  ) 
     

    Put the engine's name.

    Parameters:
    pName Name string.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IEngineStatus::Name (  [out, retval] BSTR *  pName  ) 
     

    Get the engine's name.

    Parameters:
    pName Name string.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IEngineStatus::ProductVersion (  [in] BSTR *  pProdVer  ) 
     

    Put the engine's product version.

    Parameters:
    pProdVer Product version string.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IEngineStatus::ProductVersion (  [out, retval] BSTR *  pProdVer  ) 
     

    Get the engine's product version.

    Parameters:
    pProdVer Product version string.
    Return values:
    S_OK Success.
    Remarks:
    None.