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

    List of all members.

    Public Member Functions

    HRESULT Address ([out, retval] BYTE *pAddress)
    HRESULT Create ([in] enum PeekAdapterType nType,[in] BSTR strTitle,[in] BSTR strDescription,[in] enum TMediaType nMediaType,[in] enum TMediaSubType nMediaSubType,[in] ULONG nSpeed,[in] BYTE *phyAddress)
    HRESULT Type ([out, retval] enum PeekAdapterType *pType)
    HRESULT Title ([out, retval] BSTR *pTitle)
    HRESULT Description ([out, retval] BSTR *pDescription)
    HRESULT Speed ([out, retval] ULONG *pSpeed)

    Detailed Description

    COM Wrapper for IPeekRemoteAdapter.

    This interface is implemented by PeekRemoteAdapter to wrap IPeekRemoteAdapter for Scripting clients to a remote adapter's properties.

    Member Function Documentation

    HRESULT IPeekRemoteAdapter::Address (  [out, retval] BYTE *  pAddress  ) 
     

    Get the remote adapter's address.

    Parameters:
    pAddress BYTE address.
    Return values:
    S_OK Success.
    E_POINTER Invalid pointer passed in.
    Remarks:
    None.
    HRESULT IPeekRemoteAdapter::Create (  [in] enum PeekAdapterType  nType,
    [in] BSTR  strTitle,
    [in] BSTR  strDescription,
    [in] enum TMediaType  nMediaType,
    [in] enum TMediaSubType  nMediaSubType,
    [in] ULONG  nSpeed,
    [in] BYTE *  phyAddress
    ) 
     

    Create a PeekRemoteAdapter.

    Parameters:
    nType PeekAdapterType enum.
    strTitle Title string.
    strDescription Description string.
    nMediaType TMediaType enum.
    nMediaSubType TMediaSubType enum.
    nSpeed Speed integer.
    phyAddress BYTE address.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IPeekRemoteAdapter::Description (  [out, retval] BSTR *  pDescription  ) 
     

    Get the remote adapter's description.

    Parameters:
    pDescription Description string.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IPeekRemoteAdapter::Speed (  [out, retval] ULONG *  pSpeed  ) 
     

    Get the remote adapter's speed.

    Parameters:
    pSpeed Speed.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IPeekRemoteAdapter::Title (  [out, retval] BSTR *  pTitle  ) 
     

    Get the remote adapter's title.

    Parameters:
    pTitle Title string.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IPeekRemoteAdapter::Type (  [out, retval] enum PeekAdapterType *  pType  ) 
     

    Get the remote adapter's type.

    Parameters:
    pType PeekAdapterType enum.
    Return values:
    S_OK Success.
    Remarks:
    None.