Top Description Fields Constructors Methods
com.sun.jna.platform.win32.COM

public Class COMBindingBaseObject

extends COMInvoker
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.COM.COMEarlyBindingObject, com.sun.jna.platform.win32.COM.COMLateBindingObject
Imports
com.sun.jna.WString, com.sun.jna.platform.win32.Guid, .Guid.CLSID, .Guid.GUID, .Guid.REFIID, .Kernel32, .OaIdl, .OaIdl.DISPID, .OaIdl.DISPIDByReference, .OaIdl.EXCEPINFO, .Ole32, .OleAuto, .OleAuto.DISPPARAMS, .Variant.VARIANT, .WTypes, .WinDef, .WinDef.LCID, .WinNT.HRESULT, com.sun.jna.ptr.IntByReference, .PointerByReference
Helper class to provide basic COM support.
Author
Tobias Wolf, [email protected]

Field Summary

Modifier and TypeField and Description
private IDispatch
iDispatch

The i dispatch.

private IUnknown
iUnknown

The i unknown.

public static final WinDef.LCID
LOCALE_SYSTEM_DEFAULT

The Constant LOCALE_SYSTEM_DEFAULT.

public static final WinDef.LCID
LOCALE_USER_DEFAULT

The Constant LOCALE_USER_DEFAULT.

private PointerByReference
pDispatch

IDispatch interface reference.

private PointerByReference
pUnknown

IUnknown interface reference.

Constructor Summary

AccessConstructor and Description
public
COMBindingBaseObject(IDispatch dispatch)

public
COMBindingBaseObject(Guid.CLSID clsid, boolean useActiveInstance)

public
COMBindingBaseObject(Guid.CLSID clsid, boolean useActiveInstance, int dwClsContext)

public
COMBindingBaseObject(String progId, boolean useActiveInstance, int dwClsContext)

public
COMBindingBaseObject(String progId, boolean useActiveInstance)

Method Summary

Modifier and TypeMethod and Description
protected void
checkFailed(WinNT.HRESULT
the hr
hr)

Deprecated Use COMUtils#checkRC(com.sun.jna.platform.win32.WinNT.HRESULT)
Check failed.
public IDispatch

Returns:

the i dispatch
getIDispatch()

Gets the i dispatch.

public PointerByReference

Returns:

the i dispatch pointer
getIDispatchPointer()

Gets the i dispatch pointer.

public IUnknown

Returns:

the i unknown
getIUnknown()

Gets the i unknown.

public PointerByReference

Returns:

the i unknown pointer
getIUnknownPointer()

Gets the i unknown pointer.

private void
init(boolean useActiveInstance, Guid.GUID clsid, int dwClsContext)

protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, String name, Variant.VARIANT[] pArgs)

protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, OaIdl.DISPID dispId, Variant.VARIANT[] pArgs)

protected WinNT.HRESULT

Returns:

the hresult
oleMethod(int
the n type
nType, Variant.VARIANT.ByReference
the pv result
pvResult, String
the name
name, Variant.VARIANT
the arg
pArg)

Ole method.

protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, OaIdl.DISPID dispId, Variant.VARIANT pArg)

protected WinNT.HRESULT

Returns:

the hresult
oleMethod(int
the n type
nType, Variant.VARIANT.ByReference
the pv result
pvResult, String
the name
name)

Ole method.

protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, OaIdl.DISPID dispId)

protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name, Variant.VARIANT[] pArgs)

Deprecated COMBindingBaseObject#oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, java.lang.String, com.sun.jna.platform.win32.Variant.VARIANT[])
protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId, Variant.VARIANT[] pArgs)

Deprecated COMBindingBaseObject#oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, com.sun.jna.platform.win32.OaIdl.DISPID, com.sun.jna.platform.win32.Variant.VARIANT[])
protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name, Variant.VARIANT pArg)

Deprecated Use oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, java.lang.String, com.sun.jna.platform.win32.Variant.VARIANT)
protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId, Variant.VARIANT pArg)

Deprecated Use oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, com.sun.jna.platform.win32.OaIdl.DISPID, com.sun.jna.platform.win32.Variant.VARIANT)
protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name)

Deprecated Use oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, java.lang.String)
protected WinNT.HRESULT
oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId)

Deprecated Use oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, com.sun.jna.platform.win32.OaIdl.DISPID)
public void
release()

Release.

Inherited from com.sun.jna.platform.win32.COM.COMInvoker:
_invokeNativeInt_invokeNativeObject_invokeNativeVoid

Field Detail

iDispatchback to summary
private IDispatch iDispatch

The i dispatch.

iUnknownback to summary
private IUnknown iUnknown

The i unknown.

LOCALE_SYSTEM_DEFAULTback to summary
public static final WinDef.LCID LOCALE_SYSTEM_DEFAULT

The Constant LOCALE_SYSTEM_DEFAULT.

LOCALE_USER_DEFAULTback to summary
public static final WinDef.LCID LOCALE_USER_DEFAULT

The Constant LOCALE_USER_DEFAULT.

pDispatchback to summary
private PointerByReference pDispatch

IDispatch interface reference.

pUnknownback to summary
private PointerByReference pUnknown

IUnknown interface reference.

Constructor Detail

COMBindingBaseObjectback to summary
public COMBindingBaseObject(IDispatch dispatch)
COMBindingBaseObjectback to summary
public COMBindingBaseObject(Guid.CLSID clsid, boolean useActiveInstance)
COMBindingBaseObjectback to summary
public COMBindingBaseObject(Guid.CLSID clsid, boolean useActiveInstance, int dwClsContext)
COMBindingBaseObjectback to summary
public COMBindingBaseObject(String progId, boolean useActiveInstance, int dwClsContext) throws COMException
COMBindingBaseObjectback to summary
public COMBindingBaseObject(String progId, boolean useActiveInstance) throws COMException

Method Detail

checkFailedback to summary
protected void checkFailed(WinNT.HRESULT hr)

Deprecated

Use COMUtils#checkRC(com.sun.jna.platform.win32.WinNT.HRESULT)

Check failed.

Parameters
hr:WinNT.HRESULT

the hr

Annotations
@Deprecated
getIDispatchback to summary
public IDispatch getIDispatch()

Gets the i dispatch.

Returns:IDispatch

the i dispatch

getIDispatchPointerback to summary
public PointerByReference getIDispatchPointer()

Gets the i dispatch pointer.

Returns:PointerByReference

the i dispatch pointer

getIUnknownback to summary
public IUnknown getIUnknown()

Gets the i unknown.

Returns:IUnknown

the i unknown

getIUnknownPointerback to summary
public PointerByReference getIUnknownPointer()

Gets the i unknown pointer.

Returns:PointerByReference

the i unknown pointer

initback to summary
private void init(boolean useActiveInstance, Guid.GUID clsid, int dwClsContext) throws COMException
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, String name, Variant.VARIANT[] pArgs) throws COMException
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, OaIdl.DISPID dispId, Variant.VARIANT[] pArgs) throws COMException
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, String name, Variant.VARIANT pArg) throws COMException

Ole method.

Parameters
nType:int

the n type

pvResult:Variant.VARIANT.ByReference

the pv result

name:String

the name

pArg:Variant.VARIANT

the arg

Returns:WinNT.HRESULT

the hresult

Exceptions
COMException:
the cOM exception
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, OaIdl.DISPID dispId, Variant.VARIANT pArg) throws COMException
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, String name) throws COMException

Ole method.

Parameters
nType:int

the n type

pvResult:Variant.VARIANT.ByReference

the pv result

name:String

the name

Returns:WinNT.HRESULT

the hresult

Exceptions
COMException:
the cOM exception
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, OaIdl.DISPID dispId) throws COMException
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name, Variant.VARIANT[] pArgs) throws COMException

Deprecated

COMBindingBaseObject#oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, java.lang.String, com.sun.jna.platform.win32.Variant.VARIANT[])

Annotations
@Deprecated
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId, Variant.VARIANT[] pArgs) throws COMException

Deprecated

COMBindingBaseObject#oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, com.sun.jna.platform.win32.OaIdl.DISPID, com.sun.jna.platform.win32.Variant.VARIANT[])

Annotations
@Deprecated
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name, Variant.VARIANT pArg) throws COMException

Deprecated

Use oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, java.lang.String, com.sun.jna.platform.win32.Variant.VARIANT)

Annotations
@Deprecated
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId, Variant.VARIANT pArg) throws COMException

Deprecated

Use oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, com.sun.jna.platform.win32.OaIdl.DISPID, com.sun.jna.platform.win32.Variant.VARIANT)

Annotations
@Deprecated
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name) throws COMException

Deprecated

Use oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, java.lang.String)

Annotations
@Deprecated
oleMethodback to summary
protected WinNT.HRESULT oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId) throws COMException

Deprecated

Use oleMethod(int, com.sun.jna.platform.win32.Variant.VARIANT.ByReference, com.sun.jna.platform.win32.OaIdl.DISPID)

Annotations
@Deprecated
releaseback to summary
public void release()

Release.