|
JNA API> 4.0.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OleAuto
Oleaut32.dll Interface.
Nested Class Summary | |
---|---|
static class |
OleAuto.DISPPARAMS
The Class DISPPARAMS. |
Nested classes/interfaces inherited from interface com.sun.jna.win32.StdCallLibrary |
---|
StdCallLibrary.StdCallCallback |
Nested classes/interfaces inherited from interface com.sun.jna.Library |
---|
Library.Handler |
Field Summary | |
---|---|
static int |
DISPATCH_METHOD
The Constant DISPATCH_METHOD. |
static int |
DISPATCH_PROPERTYGET
The Constant DISPATCH_PROPERTYGET. |
static int |
DISPATCH_PROPERTYPUT
The Constant DISPATCH_PROPERTYPUT. |
static int |
DISPATCH_PROPERTYPUTREF
The Constant DISPATCH_PROPERTYPUTREF. |
static int |
FADF_AUTO
An array that is allocated on the stac. |
static int |
FADF_BSTR
An array of BSTRs. |
static int |
FADF_DISPATCH
An array of IDispatch*. |
static int |
FADF_EMBEDDED
An array that is embedded in a structure. |
static int |
FADF_FIXEDSIZE
An array that is embedded in a structure. |
static int |
FADF_HAVEIID
An array that is embedded in a structure. |
static int |
FADF_HAVEVARTYPE
An array that has a variant type. |
static int |
FADF_RECORD
An array that is embedded in a structure. |
static int |
FADF_RESERVED
Bits reserved for future use. |
static int |
FADF_STATIC
An array that is statically allocated. |
static int |
FADF_UNKNOWN
An array of IUnknown*. |
static int |
FADF_VARIANT
An array of VARIANTs. |
static OleAuto |
INSTANCE
The instance. |
Fields inherited from interface com.sun.jna.win32.StdCallLibrary |
---|
FUNCTION_MAPPER, STDCALL_CONVENTION |
Fields inherited from interface com.sun.jna.Library |
---|
OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER |
Method Summary | |
---|---|
WinNT.HRESULT |
GetActiveObject(Guid.GUID rclsid,
WinDef.PVOID pvReserved,
PointerByReference ppunk)
Retrieves a pointer to a running object that has been registered with OLE. |
WinNT.HRESULT |
LoadRegTypeLib(Guid.GUID rguid,
int wVerMajor,
int wVerMinor,
WinDef.LCID lcid,
PointerByReference pptlib)
Uses registry information to load a type library. |
WinNT.HRESULT |
LoadTypeLib(WString szFile,
ITypeLib pptlib)
Loads and registers a type library. |
OaIdl.SAFEARRAY |
SafeArrayCreate(WTypes.VARTYPE vt,
int cDims,
OaIdl.SAFEARRAYBOUND[] rgsabound)
Creates a new array descriptor, allocates and initializes the data for the array, and returns a pointer to the new array descriptor. |
WinNT.HRESULT |
SafeArrayGetElement(OaIdl.SAFEARRAY psa,
long[] rgIndices,
Pointer pv)
Retrieves a single element of the array. |
WinNT.HRESULT |
SafeArrayLock(OaIdl.SAFEARRAY psa)
Increments the lock count of an array, and places a pointer to the array data in pvData of the array descriptor. |
WinNT.HRESULT |
SafeArrayPutElement(OaIdl.SAFEARRAY psa,
long[] idx,
Variant.VARIANT pv)
Stores the data element at the specified location in the array. |
WinNT.HRESULT |
SafeArrayUnLock(OaIdl.SAFEARRAY psa)
Decrements the lock count of an array so it can be freed or resized. |
WTypes.BSTR |
SysAllocString(String sz)
This function allocates a new string and copies the passed string into it. |
void |
SysFreeString(WTypes.BSTR bstr)
This function frees a string allocated previously by SysAllocString, SysAllocStringByteLen, SysReAllocString, SysAllocStringLen, or SysReAllocStringLen. |
int |
SystemTimeToVariantTime(WinBase.SYSTEMTIME lpSystemTime,
DoubleByReference pvtime)
Converts a system time to a variant representation. |
WinNT.HRESULT |
VariantClear(Pointer pvarg)
Use this function to clear variables of type VARIANTARG (or VARIANT) before the memory containing the VARIANTARG is freed (as when a local variable goes out of scope). |
WinNT.HRESULT |
VariantCopy(Pointer pvargDest,
Variant.VARIANT pvargSrc)
First, free any memory that is owned by pvargDest, such as VariantClear (pvargDest must point to a valid initialized variant, and not simply to an uninitialized memory location). |
void |
VariantInit(Variant.VARIANT pvarg)
The VariantInit function initializes the VARIANTARG by setting the vt field to VT_EMPTY. |
Field Detail |
---|
static final int DISPATCH_METHOD
static final int DISPATCH_PROPERTYGET
static final int DISPATCH_PROPERTYPUT
static final int DISPATCH_PROPERTYPUTREF
static final int FADF_AUTO
static final int FADF_STATIC
static final int FADF_EMBEDDED
static final int FADF_FIXEDSIZE
static final int FADF_RECORD
static final int FADF_HAVEIID
static final int FADF_HAVEVARTYPE
static final int FADF_BSTR
static final int FADF_UNKNOWN
static final int FADF_DISPATCH
static final int FADF_VARIANT
static final int FADF_RESERVED
static final OleAuto INSTANCE
Method Detail |
---|
WTypes.BSTR SysAllocString(String sz)
sz
- Null-terminated UNICODE string to copy.
void SysFreeString(WTypes.BSTR bstr)
bstr
- Unicode string that was allocated previously, or NULL. Setting
this parameter to NULL causes the function to simply return.void VariantInit(Variant.VARIANT pvarg)
pvarg
- The variant to initialize.WinNT.HRESULT VariantCopy(Pointer pvargDest, Variant.VARIANT pvargSrc)
pvargDest
- [out] The destination variant.pvargSrc
- [in] The source variant.
WinNT.HRESULT VariantClear(Pointer pvarg)
pvarg
- [in, out] The variant to clear.
OaIdl.SAFEARRAY SafeArrayCreate(WTypes.VARTYPE vt, int cDims, OaIdl.SAFEARRAYBOUND[] rgsabound)
vt
- [in] The base type of the array (the VARTYPE of each element
of the array). The VARTYPE is restricted to a subset of the
variant types. Neither the VT_ARRAY nor the VT_BYREF flag can
be set. VT_EMPTY and VT_NULL are not valid base types for the
array. All other types are legal. cDimscDims
- the c dimsrgsabound
- the rgsabound
WinNT.HRESULT SafeArrayPutElement(OaIdl.SAFEARRAY psa, long[] idx, Variant.VARIANT pv)
psa
- [in] An array descriptor created by SafeArrayCreate.idx
- the idxpv
- [in] The data to assign to the array. The variant types
VT_DISPATCH, VT_UNKNOWN, and VT_BSTR are pointers, and do not
require another level of indirection.
WinNT.HRESULT SafeArrayGetElement(OaIdl.SAFEARRAY psa, long[] rgIndices, Pointer pv)
psa
- [in] An array descriptor created by SafeArrayCreate.rgIndices
- [in] A vector of indexes for each dimension of the array. The
right-most (least significant) dimension is rgIndices[0]. The
left-most dimension is stored at rgIndices[psa->cDims - 1].pv
- [out] The element of the array.
WinNT.HRESULT SafeArrayLock(OaIdl.SAFEARRAY psa)
psa
- [in] An array descriptor created by SafeArrayCreate.
WinNT.HRESULT SafeArrayUnLock(OaIdl.SAFEARRAY psa)
psa
- [in] An array descriptor created by SafeArrayCreate.
WinNT.HRESULT GetActiveObject(Guid.GUID rclsid, WinDef.PVOID pvReserved, PointerByReference ppunk)
rclsid
- [in] The class identifier (CLSID) of the active object from
the OLE registration database.pvReserved
- Reserved for future use. Must be null.ppunk
- [out] The requested active object.
WinNT.HRESULT LoadRegTypeLib(Guid.GUID rguid, int wVerMajor, int wVerMinor, WinDef.LCID lcid, PointerByReference pptlib)
rguid
- The GUID of the library.wVerMajor
- The major version of the library.wVerMinor
- The minor version of the library.lcid
- The national language code of the library.pptlib
- The loaded type library.
This function can return one of these values: S_OK Success.
E_INVALIDARG One or more of the arguments is not valid.
E_OUTOFMEMORY Insufficient memory to complete the operation.
TYPE_E_IOERROR The function could not write to the file.
TYPE_E_INVALIDSTATE The type library could not be opened.
TYPE_E_INVDATAREAD The function could not read from the file.
TYPE_E_UNSUPFORMAT The type library has an older format.
TYPE_E_UNKNOWNLCID The LCID could not be found in the
OLE-supported DLLs.
TYPE_E_CANTLOADLIBRARY The type library or DLL could not be
loaded.WinNT.HRESULT LoadTypeLib(WString szFile, ITypeLib pptlib)
szFile
- The name of the file from which the method should attempt to
load a type library.pptlib
- The loaded type library. Return value
This function can return one of these values.
S_OK Success.
E_INVALIDARG One or more of the arguments is not valid.
E_OUTOFMEMORY Insufficient memory to complete the operation.
TYPE_E_IOERROR The function could not write to the file.
TYPE_E_INVALIDSTATE The type library could not be opened.
TYPE_E_INVDATAREAD The function could not read from the file.
TYPE_E_UNSUPFORMAT The type library has an older format.
TYPE_E_UNKNOWNLCID The LCID could not be found in the
OLE-supported DLLs.
TYPE_E_CANTLOADLIBRARY The type library or DLL could not be
loaded.int SystemTimeToVariantTime(WinBase.SYSTEMTIME lpSystemTime, DoubleByReference pvtime)
lpSystemTime
- [in] The system time.pvtime
- [out] The variant time.
|
JNA API> 4.0.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |