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

    List of all members.

    Public Member Functions

    HRESULT TriggerBytes ([out, retval] ULONG *pulTriggeredBytes)
    HRESULT TriggerBytes ([in] ULONG ulTriggeredBytes)
    HRESULT TriggerFilter ([out, retval] IFilter **ppTriggerFilter)
    HRESULT TriggerFilter ([in] IFilter *pTriggerFilter)
    HRESULT ElapsedTriggerTime ([in] ULONG ulTriggerTime)
    HRESULT ElapsedTriggerTime ([out, retval] ULONG *pulTriggerTime)
    HRESULT Trigger ([out, retval] ITrigger **ppTrigger)
    HRESULT Trigger ([in] ITrigger *pTrigger)
    HRESULT TriggerEnabled ([out, retval] BOOL *pEnableTrigger)
    HRESULT TriggerEnabled ([in] BOOL bEnableTrigger)
    HRESULT GetTriggerTimeDay ([out] WORD *pulYear,[out] WORD *pulMonth,[out] WORD *pulDay,[out] WORD *pulHour,[out] WORD *pulMinute,[out] WORD *pulSecond,[out, retval] BOOL *pbUseDate)
    HRESULT SetTriggerDateTime ([in] WORD ulYear,[in] WORD ulMonth,[in] WORD ulDay,[in] WORD ulHour,[in] WORD ulMinute,[in] WORD ulSecond,[in] BOOL bUseDate)

    Detailed Description

    COM Wrapper for ITrigger.

    This interface is implemented by CSimpleTrigger to wrap ITrigger for Scripting clients to access basic functionality of a trigger.

    Member Function Documentation

    HRESULT ISimpleTrigger::ElapsedTriggerTime (  [out, retval] ULONG *  pulTriggerTime  ) 
     

    Set trigger time to trigger on.

    Parameters:
    pulTriggerTime Amount of elapsed trigger time.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT ISimpleTrigger::ElapsedTriggerTime (  [in] ULONG  ulTriggerTime  ) 
     

    Set trigger time being triggered on.

    Parameters:
    ulTriggerTime Amount of elapsed trigger time.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_FAIL Can't find a trigger time event.
    Remarks:
    None.
    HRESULT ISimpleTrigger::GetTriggerTimeDay (  [out] WORD *  pulYear,
    [out] WORD *  pulMonth,
    [out] WORD *  pulDay,
    [out] WORD *  pulHour,
    [out] WORD *  pulMinute,
    [out] WORD *  pulSecond,
    [out, retval] BOOL *  pbUseDate
    ) 
     

    Get trigger time being triggered on.

    Parameters:
    pulYear Year.
    pulMonth Month.
    pulDay Day.
    pulHour Hour.
    pulMinute Minute.
    pulSecond Second.
    pbUseDate Boolean for use date.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_FAIL Can't find a trigger time event.
    Remarks:
    None.
    HRESULT ISimpleTrigger::SetTriggerDateTime (  [in] WORD  ulYear,
    [in] WORD  ulMonth,
    [in] WORD  ulDay,
    [in] WORD  ulHour,
    [in] WORD  ulMinute,
    [in] WORD  ulSecond,
    [in] BOOL  bUseDate
    ) 
     

    Set trigger time to trigger on.

    Parameters:
    ulYear Year.
    ulMonth Month.
    ulDay Day.
    ulHour Hour.
    ulMinute Minute.
    ulSecond Second.
    bUseDate Boolean for use date.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_FAIL Can't find a trigger time event.
    Remarks:
    None.
    HRESULT ISimpleTrigger::Trigger (  [in] ITrigger *  pTrigger  ) 
     

    Set actual ITrigger.

    Parameters:
    pTrigger ITrigger.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT ISimpleTrigger::Trigger (  [out, retval] ITrigger **  ppTrigger  ) 
     

    Get actual ITrigger.

    Parameters:
    ppTrigger Trigger.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_FAIL Can't find a trigger time event.
    Remarks:
    None.
    HRESULT ISimpleTrigger::TriggerBytes (  [in] ULONG  ulTriggeredBytes  ) 
     

    Set trigger bytes to trigger on.

    Parameters:
    ulTriggeredBytes Number of triggered bytes.
    Return values:
    S_OK Success.
    E_FAIL Failure.
    Remarks:
    None.
    HRESULT ISimpleTrigger::TriggerBytes (  [out, retval] ULONG *  pulTriggeredBytes  ) 
     

    Get trigger bytes being triggered on.

    Parameters:
    pulTriggeredBytes Number of triggered bytes.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_FAIL Can't find a trigger bytes event.
    Remarks:
    None.
    HRESULT ISimpleTrigger::TriggerEnabled (  [in] BOOL  bEnableTrigger  ) 
     

    Set Trigger enabled value.

    Parameters:
    bEnableTrigger Boolean if trigger enabled.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT ISimpleTrigger::TriggerEnabled (  [out, retval] BOOL *  pEnableTrigger  ) 
     

    Get Trigger enabled value.

    Parameters:
    pEnableTrigger Boolean if trigger enabled.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    Remarks:
    None.
    HRESULT ISimpleTrigger::TriggerFilter (  [in] IFilter *  pTriggerFilter  ) 
     

    Set trigger filter to trigger on.

    Parameters:
    pTriggerFilter Trigger filter.
    Return values:
    E_NOTIMPL Method not implemented.
    Remarks:
    None.
    HRESULT ISimpleTrigger::TriggerFilter (  [out, retval] IFilter **  ppTriggerFilter  ) 
     

    Get trigger filter being triggered on.

    Parameters:
    ppTriggerFilter Trigger filter.
    Return values:
    E_NOTIMPL Method not implemented.
    Remarks:
    None.