Plugin

Overview

The Plugin is a abstract base class for a Hydra plugins.

Location

Reference: Hydra.fx
Namespace: Hydra
Platforms: Island
Ancestry: InterfacedObject | FakeIDispatch | Plugin

get_Host

Returnds the reference to the plugin host interface.

method get_Host(out aResult: IHYCrossPlatformHost): HRESULT

HRESULT get_Host(out IHYCrossPlatformHost aResult)

func get_Host(_ aResult: IHYCrossPlatformHost) -> HRESULT

Function get_Host(<OutAttribute> ByRef aResult As IHYCrossPlatformHost) As HRESULT

Parameters:

aResult: result

GetIDsOfNames (declared in FakeIDispatch)

Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs. Empty.

// Island-Ubuntu
method GetIDsOfNames(riid: REFIID; rgszNames: ^^Char; cNames: UInt32; lcid: UInt32; rgDispId: ^Int32): HRESULT
// Island-Windows
method GetIDsOfNames(riid: REFIID; rgszNames: ^^WCHAR; cNames: UINT; lcid: LCID; rgDispId: ^DISPID): HRESULT

// Island-Ubuntu
HRESULT GetIDsOfNames(REFIID riid, Char** rgszNames, UInt32 cNames, UInt32 lcid, Int32* rgDispId)
// Island-Windows
HRESULT GetIDsOfNames(REFIID riid, WCHAR** rgszNames, UINT cNames, LCID lcid, DISPID* rgDispId)

// Island-Ubuntu
func GetIDsOfNames(_ riid: REFIID, _ rgszNames: UnsafeMutablePointer<UnsafeMutablePointer<Char>>, _ cNames: UInt32, _ lcid: UInt32, _ rgDispId: UnsafeMutablePointer<Int32>) -> HRESULT
// Island-Windows
func GetIDsOfNames(_ riid: REFIID, _ rgszNames: UnsafeMutablePointer<UnsafeMutablePointer<WCHAR>>, _ cNames: UINT, _ lcid: LCID, _ rgDispId: UnsafeMutablePointer<DISPID>) -> HRESULT

// Island-Ubuntu
Function GetIDsOfNames(riid As REFIID, rgszNames As Ptr(Of Ptr(Of Char)), cNames As UInt32, lcid As UInt32, rgDispId As Ptr(Of Int32)) As HRESULT
// Island-Windows
Function GetIDsOfNames(riid As REFIID, rgszNames As Ptr(Of Ptr(Of WCHAR)), cNames As UINT, lcid As LCID, rgDispId As Ptr(Of DISPID)) As HRESULT

Parameters:

riid: Reserved for future use. Must be IID_NULL.
rgszNames: The array of names to be mapped.
cNames: The count of the names to be mapped.
lcid: The locale context in which to interpret the names.
rgDispId: Caller-allocated array, each element of which contains an identifier (ID) corresponding to one of the names passed in the rgszNames array.

GetTypeInfo (declared in FakeIDispatch)

Retrieves the type information for an object, which can then be used to get the type information for an interface. Empty.

// Island-Ubuntu
method GetTypeInfo(iTInfo: UInt32; lcid: UInt32; ppTInfo: ^ITypeInfo): HRESULT
// Island-Windows
method GetTypeInfo(iTInfo: UINT; lcid: LCID; ppTInfo: ^ITypeInfo): HRESULT

// Island-Ubuntu
HRESULT GetTypeInfo(UInt32 iTInfo, UInt32 lcid, ITypeInfo* ppTInfo)
// Island-Windows
HRESULT GetTypeInfo(UINT iTInfo, LCID lcid, ITypeInfo* ppTInfo)

// Island-Ubuntu
func GetTypeInfo(_ iTInfo: UInt32, _ lcid: UInt32, _ ppTInfo: UnsafeMutablePointer<ITypeInfo>) -> HRESULT
// Island-Windows
func GetTypeInfo(_ iTInfo: UINT, _ lcid: LCID, _ ppTInfo: UnsafeMutablePointer<ITypeInfo>) -> HRESULT

// Island-Ubuntu
Function GetTypeInfo(iTInfo As UInt32, lcid As UInt32, ppTInfo As Ptr(Of ITypeInfo)) As HRESULT
// Island-Windows
Function GetTypeInfo(iTInfo As UINT, lcid As LCID, ppTInfo As Ptr(Of ITypeInfo)) As HRESULT

Parameters:

iTInfo: Index of the type information to return.
lcid: The locale identifier for the type information.
ppTInfo: The requested type information object.

GetTypeInfoCount (declared in FakeIDispatch)

Retrieves the number of type information interfaces that an object provides (either 0 or 1). Empty

// Island-Ubuntu
method GetTypeInfoCount(pctinfo: ^UInt32): HRESULT
// Island-Windows
method GetTypeInfoCount(pctinfo: ^UINT): HRESULT

// Island-Ubuntu
HRESULT GetTypeInfoCount(UInt32* pctinfo)
// Island-Windows
HRESULT GetTypeInfoCount(UINT* pctinfo)

// Island-Ubuntu
func GetTypeInfoCount(_ pctinfo: UnsafeMutablePointer<UInt32>) -> HRESULT
// Island-Windows
func GetTypeInfoCount(_ pctinfo: UnsafeMutablePointer<UINT>) -> HRESULT

// Island-Ubuntu
Function GetTypeInfoCount(pctinfo As Ptr(Of UInt32)) As HRESULT
// Island-Windows
Function GetTypeInfoCount(pctinfo As Ptr(Of UINT)) As HRESULT

Parameters:

pctinfo: The number of type information interfaces provided by the object. If the object provides type information, this number is 1; otherwise the number is 0.

Host

Holds the reference to the plugin host interface.

property Host: IHYCrossPlatformHost read;

IHYCrossPlatformHost Host { get; }

var Host: IHYCrossPlatformHost { get{} }

ReadOnly Property Host() As IHYCrossPlatformHost

HostChanged virtual

This event if fired whenever reference to a host is changed.

method HostChanged(value: IHYCrossPlatformHost)

void HostChanged(IHYCrossPlatformHost value)

func HostChanged(_ value: IHYCrossPlatformHost)

Sub HostChanged(value As IHYCrossPlatformHost)

Parameters:

value: host

Invoke (declared in FakeIDispatch)

Provides access to properties and methods exposed by an object. Empty.

// Island-Ubuntu
method Invoke(dispIdMember: Int32; riid: REFIID; lcid: UInt32; wFlags: UInt16; pDispParams: ^DISPPARAMS; pVarResult: ^VARIANT; pExcepInfo: ^EXCEPINFO; puArgErr: ^UInt32): HRESULT
// Island-Windows
method Invoke(dispIdMember: DISPID; riid: REFIID; lcid: LCID; wFlags: WORD; pDispParams: ^DISPPARAMS; pVarResult: ^VARIANT; pExcepInfo: ^EXCEPINFO; puArgErr: ^UINT): HRESULT

// Island-Ubuntu
HRESULT Invoke(Int32 dispIdMember, REFIID riid, UInt32 lcid, UInt16 wFlags, DISPPARAMS* pDispParams, VARIANT* pVarResult, EXCEPINFO* pExcepInfo, UInt32* puArgErr)
// Island-Windows
HRESULT Invoke(DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS* pDispParams, VARIANT* pVarResult, EXCEPINFO* pExcepInfo, UINT* puArgErr)

// Island-Ubuntu
func Invoke(_ dispIdMember: Int32, _ riid: REFIID, _ lcid: UInt32, _ wFlags: UInt16, _ pDispParams: UnsafeMutablePointer<DISPPARAMS>, _ pVarResult: UnsafeMutablePointer<VARIANT>, _ pExcepInfo: UnsafeMutablePointer<EXCEPINFO>, _ puArgErr: UnsafeMutablePointer<UInt32>) -> HRESULT
// Island-Windows
func Invoke(_ dispIdMember: DISPID, _ riid: REFIID, _ lcid: LCID, _ wFlags: WORD, _ pDispParams: UnsafeMutablePointer<DISPPARAMS>, _ pVarResult: UnsafeMutablePointer<VARIANT>, _ pExcepInfo: UnsafeMutablePointer<EXCEPINFO>, _ puArgErr: UnsafeMutablePointer<UINT>) -> HRESULT

// Island-Ubuntu
Function Invoke(dispIdMember As Int32, riid As REFIID, lcid As UInt32, wFlags As UInt16, pDispParams As Ptr(Of DISPPARAMS), pVarResult As Ptr(Of VARIANT), pExcepInfo As Ptr(Of EXCEPINFO), puArgErr As Ptr(Of UInt32)) As HRESULT
// Island-Windows
Function Invoke(dispIdMember As DISPID, riid As REFIID, lcid As LCID, wFlags As WORD, pDispParams As Ptr(Of DISPPARAMS), pVarResult As Ptr(Of VARIANT), pExcepInfo As Ptr(Of EXCEPINFO), puArgErr As Ptr(Of UINT)) As HRESULT

Parameters:

dispIdMember: Identifies the member.
riid: Reserved for future use. Must be IID_NULL.
lcid: The locale context in which to interpret arguments.
wFlags: Flags describing the context of the Invoke call.
pDispParams: Pointer to a DISPPARAMS structure containing an array of arguments, an array of argument DISPIDs for named arguments, and counts for the number of elements in the arrays.
pVarResult: Pointer to the location where the result is to be stored, or nil if the caller expects no result.
pExcepInfo: Pointer to a structure that contains exception information.
puArgErr: The index within rgvarg of the first argument that has an error.

set_Host

Sets the reference to the plugin host interface.

method set_Host(value: IHYCrossPlatformHost): HRESULT

HRESULT set_Host(IHYCrossPlatformHost value)

func set_Host(_ value: IHYCrossPlatformHost) -> HRESULT

Function set_Host(value As IHYCrossPlatformHost) As HRESULT

Parameters:

value: host

Host

Holds the reference to the plugin host interface.

property Host: IHYCrossPlatformHost read;

IHYCrossPlatformHost Host { get; }

var Host: IHYCrossPlatformHost { get{} }

ReadOnly Property Host() As IHYCrossPlatformHost

get_Host

Returnds the reference to the plugin host interface.

method get_Host(out aResult: IHYCrossPlatformHost): HRESULT

HRESULT get_Host(out IHYCrossPlatformHost aResult)

func get_Host(_ aResult: IHYCrossPlatformHost) -> HRESULT

Function get_Host(<OutAttribute> ByRef aResult As IHYCrossPlatformHost) As HRESULT

Parameters:

aResult: result

GetIDsOfNames (declared in FakeIDispatch)

Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs. Empty.

// Island-Ubuntu
method GetIDsOfNames(riid: REFIID; rgszNames: ^^Char; cNames: UInt32; lcid: UInt32; rgDispId: ^Int32): HRESULT
// Island-Windows
method GetIDsOfNames(riid: REFIID; rgszNames: ^^WCHAR; cNames: UINT; lcid: LCID; rgDispId: ^DISPID): HRESULT

// Island-Ubuntu
HRESULT GetIDsOfNames(REFIID riid, Char** rgszNames, UInt32 cNames, UInt32 lcid, Int32* rgDispId)
// Island-Windows
HRESULT GetIDsOfNames(REFIID riid, WCHAR** rgszNames, UINT cNames, LCID lcid, DISPID* rgDispId)

// Island-Ubuntu
func GetIDsOfNames(_ riid: REFIID, _ rgszNames: UnsafeMutablePointer<UnsafeMutablePointer<Char>>, _ cNames: UInt32, _ lcid: UInt32, _ rgDispId: UnsafeMutablePointer<Int32>) -> HRESULT
// Island-Windows
func GetIDsOfNames(_ riid: REFIID, _ rgszNames: UnsafeMutablePointer<UnsafeMutablePointer<WCHAR>>, _ cNames: UINT, _ lcid: LCID, _ rgDispId: UnsafeMutablePointer<DISPID>) -> HRESULT

// Island-Ubuntu
Function GetIDsOfNames(riid As REFIID, rgszNames As Ptr(Of Ptr(Of Char)), cNames As UInt32, lcid As UInt32, rgDispId As Ptr(Of Int32)) As HRESULT
// Island-Windows
Function GetIDsOfNames(riid As REFIID, rgszNames As Ptr(Of Ptr(Of WCHAR)), cNames As UINT, lcid As LCID, rgDispId As Ptr(Of DISPID)) As HRESULT

Parameters:

riid: Reserved for future use. Must be IID_NULL.
rgszNames: The array of names to be mapped.
cNames: The count of the names to be mapped.
lcid: The locale context in which to interpret the names.
rgDispId: Caller-allocated array, each element of which contains an identifier (ID) corresponding to one of the names passed in the rgszNames array.

GetTypeInfo (declared in FakeIDispatch)

Retrieves the type information for an object, which can then be used to get the type information for an interface. Empty.

// Island-Ubuntu
method GetTypeInfo(iTInfo: UInt32; lcid: UInt32; ppTInfo: ^ITypeInfo): HRESULT
// Island-Windows
method GetTypeInfo(iTInfo: UINT; lcid: LCID; ppTInfo: ^ITypeInfo): HRESULT

// Island-Ubuntu
HRESULT GetTypeInfo(UInt32 iTInfo, UInt32 lcid, ITypeInfo* ppTInfo)
// Island-Windows
HRESULT GetTypeInfo(UINT iTInfo, LCID lcid, ITypeInfo* ppTInfo)

// Island-Ubuntu
func GetTypeInfo(_ iTInfo: UInt32, _ lcid: UInt32, _ ppTInfo: UnsafeMutablePointer<ITypeInfo>) -> HRESULT
// Island-Windows
func GetTypeInfo(_ iTInfo: UINT, _ lcid: LCID, _ ppTInfo: UnsafeMutablePointer<ITypeInfo>) -> HRESULT

// Island-Ubuntu
Function GetTypeInfo(iTInfo As UInt32, lcid As UInt32, ppTInfo As Ptr(Of ITypeInfo)) As HRESULT
// Island-Windows
Function GetTypeInfo(iTInfo As UINT, lcid As LCID, ppTInfo As Ptr(Of ITypeInfo)) As HRESULT

Parameters:

iTInfo: Index of the type information to return.
lcid: The locale identifier for the type information.
ppTInfo: The requested type information object.

GetTypeInfoCount (declared in FakeIDispatch)

Retrieves the number of type information interfaces that an object provides (either 0 or 1). Empty

// Island-Ubuntu
method GetTypeInfoCount(pctinfo: ^UInt32): HRESULT
// Island-Windows
method GetTypeInfoCount(pctinfo: ^UINT): HRESULT

// Island-Ubuntu
HRESULT GetTypeInfoCount(UInt32* pctinfo)
// Island-Windows
HRESULT GetTypeInfoCount(UINT* pctinfo)

// Island-Ubuntu
func GetTypeInfoCount(_ pctinfo: UnsafeMutablePointer<UInt32>) -> HRESULT
// Island-Windows
func GetTypeInfoCount(_ pctinfo: UnsafeMutablePointer<UINT>) -> HRESULT

// Island-Ubuntu
Function GetTypeInfoCount(pctinfo As Ptr(Of UInt32)) As HRESULT
// Island-Windows
Function GetTypeInfoCount(pctinfo As Ptr(Of UINT)) As HRESULT

Parameters:

pctinfo: The number of type information interfaces provided by the object. If the object provides type information, this number is 1; otherwise the number is 0.

HostChanged virtual

This event if fired whenever reference to a host is changed.

method HostChanged(value: IHYCrossPlatformHost)

void HostChanged(IHYCrossPlatformHost value)

func HostChanged(_ value: IHYCrossPlatformHost)

Sub HostChanged(value As IHYCrossPlatformHost)

Parameters:

value: host

Invoke (declared in FakeIDispatch)

Provides access to properties and methods exposed by an object. Empty.

// Island-Ubuntu
method Invoke(dispIdMember: Int32; riid: REFIID; lcid: UInt32; wFlags: UInt16; pDispParams: ^DISPPARAMS; pVarResult: ^VARIANT; pExcepInfo: ^EXCEPINFO; puArgErr: ^UInt32): HRESULT
// Island-Windows
method Invoke(dispIdMember: DISPID; riid: REFIID; lcid: LCID; wFlags: WORD; pDispParams: ^DISPPARAMS; pVarResult: ^VARIANT; pExcepInfo: ^EXCEPINFO; puArgErr: ^UINT): HRESULT

// Island-Ubuntu
HRESULT Invoke(Int32 dispIdMember, REFIID riid, UInt32 lcid, UInt16 wFlags, DISPPARAMS* pDispParams, VARIANT* pVarResult, EXCEPINFO* pExcepInfo, UInt32* puArgErr)
// Island-Windows
HRESULT Invoke(DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS* pDispParams, VARIANT* pVarResult, EXCEPINFO* pExcepInfo, UINT* puArgErr)

// Island-Ubuntu
func Invoke(_ dispIdMember: Int32, _ riid: REFIID, _ lcid: UInt32, _ wFlags: UInt16, _ pDispParams: UnsafeMutablePointer<DISPPARAMS>, _ pVarResult: UnsafeMutablePointer<VARIANT>, _ pExcepInfo: UnsafeMutablePointer<EXCEPINFO>, _ puArgErr: UnsafeMutablePointer<UInt32>) -> HRESULT
// Island-Windows
func Invoke(_ dispIdMember: DISPID, _ riid: REFIID, _ lcid: LCID, _ wFlags: WORD, _ pDispParams: UnsafeMutablePointer<DISPPARAMS>, _ pVarResult: UnsafeMutablePointer<VARIANT>, _ pExcepInfo: UnsafeMutablePointer<EXCEPINFO>, _ puArgErr: UnsafeMutablePointer<UINT>) -> HRESULT

// Island-Ubuntu
Function Invoke(dispIdMember As Int32, riid As REFIID, lcid As UInt32, wFlags As UInt16, pDispParams As Ptr(Of DISPPARAMS), pVarResult As Ptr(Of VARIANT), pExcepInfo As Ptr(Of EXCEPINFO), puArgErr As Ptr(Of UInt32)) As HRESULT
// Island-Windows
Function Invoke(dispIdMember As DISPID, riid As REFIID, lcid As LCID, wFlags As WORD, pDispParams As Ptr(Of DISPPARAMS), pVarResult As Ptr(Of VARIANT), pExcepInfo As Ptr(Of EXCEPINFO), puArgErr As Ptr(Of UINT)) As HRESULT

Parameters:

dispIdMember: Identifies the member.
riid: Reserved for future use. Must be IID_NULL.
lcid: The locale context in which to interpret arguments.
wFlags: Flags describing the context of the Invoke call.
pDispParams: Pointer to a DISPPARAMS structure containing an array of arguments, an array of argument DISPIDs for named arguments, and counts for the number of elements in the arrays.
pVarResult: Pointer to the location where the result is to be stored, or nil if the caller expects no result.
pExcepInfo: Pointer to a structure that contains exception information.
puArgErr: The index within rgvarg of the first argument that has an error.

set_Host

Sets the reference to the plugin host interface.

method set_Host(value: IHYCrossPlatformHost): HRESULT

HRESULT set_Host(IHYCrossPlatformHost value)

func set_Host(_ value: IHYCrossPlatformHost) -> HRESULT

Function set_Host(value As IHYCrossPlatformHost) As HRESULT

Parameters:

value: host

NonVisualPlugin