oleaut32 topic

OLE Automation API

OLE Automation APIs.

Functions

DosDateTimeToVariantTime(int wDosDate, int wDosTime, Pointer<Double> pvtime) → int

Converts the MS-DOS representation of time to the date and time representation stored in a variant.

GetActiveObject(Pointer<GUID> rclsid, Pointer<NativeType> pvReserved, Pointer<Pointer<COMObject>> ppunk) → int

Retrieves a pointer to a running object that has been registered with OLE.

SafeArrayAccessData(Pointer<SAFEARRAY> psa, Pointer<Pointer<NativeType>> ppvData) → int

Increments the lock count of an array, and retrieves a pointer to the array data.

SafeArrayAddRef(Pointer<SAFEARRAY> psa, Pointer<Pointer<NativeType>> ppDataToRelease) → int

Increases the pinning reference count of the descriptor for the specified safe array by one, and may increase the pinning reference count of the data for the specified safe array by one if that data was dynamically allocated, as determined by the descriptor of the safe array.

SafeArrayAllocData(Pointer<SAFEARRAY> psa) → int

Allocates memory for a safe array, based on a descriptor created with SafeArrayAllocDescriptor.

SafeArrayAllocDescriptor(int cDims, Pointer<Pointer<SAFEARRAY>> ppsaOut) → int

Allocates memory for a safe array descriptor.

SafeArrayAllocDescriptorEx(int vt, int cDims, Pointer<Pointer<SAFEARRAY>> ppsaOut) → int

Creates a safe array descriptor for an array of any valid variant type, including VT_RECORD, without allocating the array data.

SafeArrayCopy(Pointer<SAFEARRAY> psa, Pointer<Pointer<SAFEARRAY>> ppsaOut) → int

Creates a copy of an existing safe array.

SafeArrayCopyData(Pointer<SAFEARRAY> psaSource, Pointer<SAFEARRAY> psaTarget) → int

Copies the source array to the specified target array after releasing any resources in the target array. This is similar to SafeArrayCopy, except that the target array has to be set up by the caller. The target is not allocated or reallocated.

SafeArrayCreate(int vt, int cDims, Pointer<SAFEARRAYBOUND> rgsabound) → Pointer<SAFEARRAY>

Creates a new array descriptor, allocates and initializes the data for the array, and returns a pointer to the new array descriptor.

SafeArrayCreateEx(int vt, int cDims, Pointer<SAFEARRAYBOUND> rgsabound, Pointer<NativeType> pvExtra) → Pointer<SAFEARRAY>

Creates and returns a safe array descriptor from the specified VARTYPE, number of dimensions and bounds.

SafeArrayCreateVector(int vt, int lLbound, int cElements) → Pointer<SAFEARRAY>

Creates a one-dimensional array. A safe array created with SafeArrayCreateVector is a fixed size, so the constant FADF_FIXEDSIZE is always set.

SafeArrayCreateVectorEx(int vt, int lLbound, int cElements, Pointer<NativeType> pvExtra) → Pointer<SAFEARRAY>

Creates and returns a one-dimensional safe array of the specified VARTYPE and bounds.

SafeArrayDestroy(Pointer<SAFEARRAY> psa) → int

Destroys an existing array descriptor and all of the data in the array. If objects are stored in the array, Release is called on each object in the array.

SafeArrayDestroyData(Pointer<SAFEARRAY> psa) → int

Destroys all the data in the specified safe array.

SafeArrayDestroyDescriptor(Pointer<SAFEARRAY> psa) → int

Destroys the descriptor of the specified safe array.

SafeArrayGetDim(Pointer<SAFEARRAY> psa) → int

Gets the number of dimensions in the array.

SafeArrayGetElement(Pointer<SAFEARRAY> psa, Pointer<Int32> rgIndices, Pointer<NativeType> pv) → int

Retrieves a single element of the array.

SafeArrayGetElemsize(Pointer<SAFEARRAY> psa) → int

Gets the size of an element.

SafeArrayGetIID(Pointer<SAFEARRAY> psa, Pointer<GUID> pguid) → int

Gets the GUID of the interface contained within the specified safe array.

SafeArrayGetLBound(Pointer<SAFEARRAY> psa, int nDim, Pointer<Int32> plLbound) → int

Gets the lower bound for any dimension of the specified safe array.

SafeArrayGetRecordInfo(Pointer<SAFEARRAY> psa, Pointer<Pointer<COMObject>> prinfo) → int

Retrieves the IRecordInfo interface of the UDT contained in the specified safe array.

SafeArrayGetUBound(Pointer<SAFEARRAY> psa, int nDim, Pointer<Int32> plUbound) → int

Gets the upper bound for any dimension of the specified safe array.

SafeArrayGetVartype(Pointer<SAFEARRAY> psa, Pointer<Uint16> pvt) → int

Gets the VARTYPE stored in the specified safe array.

SafeArrayLock(Pointer<SAFEARRAY> psa) → int

Increments the lock count of an array, and places a pointer to the array data in pvData of the array descriptor.

SafeArrayPtrOfIndex(Pointer<SAFEARRAY> psa, Pointer<Int32> rgIndices, Pointer<Pointer<NativeType>> ppvData) → int

Gets a pointer to an array element.

SafeArrayPutElement(Pointer<SAFEARRAY> psa, Pointer<Int32> rgIndices, Pointer<NativeType> pv) → int

Stores the data element at the specified location in the array.

SafeArrayRedim(Pointer<SAFEARRAY> psa, Pointer<SAFEARRAYBOUND> psaboundNew) → int

Changes the right-most (least significant) bound of the specified safe array.

SafeArrayReleaseData(Pointer<NativeType> pData) → void

Decreases the pinning reference count for the specified safe array data by one. When that count reaches 0, the memory for that data is no longer prevented from being freed.

SafeArrayReleaseDescriptor(Pointer<SAFEARRAY> psa) → void

Decreases the pinning reference count for the descriptor of the specified safe array by one. When that count reaches 0, the memory for that descriptor is no longer prevented from being freed.

SafeArraySetIID(Pointer<SAFEARRAY> psa, Pointer<GUID> guid) → int

Sets the GUID of the interface for the specified safe array.

SafeArraySetRecordInfo(Pointer<SAFEARRAY> psa, Pointer<COMObject> prinfo) → int

Sets the record info in the specified safe array.

SafeArrayUnaccessData(Pointer<SAFEARRAY> psa) → int

Decrements the lock count of an array, and invalidates the pointer retrieved by SafeArrayAccessData.

SafeArrayUnlock(Pointer<SAFEARRAY> psa) → int

Decrements the lock count of an array so it can be freed or resized.

SysAllocString(Pointer<Utf16> psz) → Pointer<Utf16>

Allocates a new string and copies the passed string into it.

SysAllocStringByteLen(Pointer<Utf8> psz, int len) → Pointer<Utf16>

Takes an ANSI string as input, and returns a BSTR that contains an ANSI string. Does not perform any ANSI-to-Unicode translation.

SysAllocStringLen(Pointer<Utf16> strIn, int ui) → Pointer<Utf16>

Allocates a new string, copies the specified number of characters from the passed string, and appends a null-terminating character.

SysFreeString(Pointer<Utf16> bstrString) → void

Deallocates a string allocated previously by SysAllocString, SysAllocStringByteLen, SysReAllocString, SysAllocStringLen, or SysReAllocStringLen.

SysReAllocString(Pointer<Pointer<Utf16>> pbstr, Pointer<Utf16> psz) → int

Reallocates a previously allocated string to be the size of a second string and copies the second string into the reallocated memory.

SysReAllocStringLen(Pointer<Pointer<Utf16>> pbstr, Pointer<Utf16> psz, int len) → int

Creates a new BSTR containing a specified number of characters from an old BSTR, and frees the old BSTR.

SysReleaseString(Pointer<Utf16> bstrString) → void

Decreases the pinning reference count for the specified string by one. When that count reaches 0, the memory for that string is no longer prevented from being freed.

SysStringByteLen(Pointer<Utf16> bstr) → int

Returns the length (in bytes) of a BSTR.

SysStringLen(Pointer<Utf16> pbstr) → int

Returns the length of a BSTR.

VarBstrCat(Pointer<Utf16> bstrLeft, Pointer<Utf16> bstrRight, Pointer<Pointer<Utf16>> pbstrResult) → int

Converts a variant from one type to another.

VarBstrCmp(Pointer<Utf16> bstrLeft, Pointer<Utf16> bstrRight, int lcid, int dwFlags) → int

Compares two variants of type BSTR.

VariantChangeType(Pointer<VARIANT> pvargDest, Pointer<VARIANT> pvarSrc, int wFlags, int vt) → int

Converts a variant from one type to another.

VariantClear(Pointer<VARIANT> pvarg) → int

Clears a variant.

VariantCopy(Pointer<VARIANT> pvargDest, Pointer<VARIANT> pvargSrc) → int

Frees the destination variant and makes a copy of the source variant.

VariantInit(Pointer<VARIANT> pvarg) → void

Initializes a variant.

VariantTimeToDosDateTime(double vtime, Pointer<Uint16> pwDosDate, Pointer<Uint16> pwDosTime) → int

Converts the variant representation of a date and time to MS-DOS date and time values.

VariantTimeToSystemTime(double vtime, Pointer<SYSTEMTIME> lpSystemTime) → int

Converts the variant representation of time to system time values.