1 /*************************************************************************
2 * OLE Automation - SafeArray
4 * This file contains the implementation of the SafeArray functions.
6 * Copyright 1999 Sylvain St-Germain
7 * Copyright 2002-2003 Marcus Meissner
8 * Copyright 2003 Jon Griffiths
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 /* Memory Layout of a SafeArray:
26 * -0x10: start of memory.
27 * -0x10: GUID for VT_DISPATCH and VT_UNKNOWN safearrays (if FADF_HAVEIID)
28 * -0x04: DWORD varianttype; (for all others, except VT_RECORD) (if FADF_HAVEVARTYPE)
29 * -0x4: IRecordInfo* iface; (if FADF_RECORD, for VT_RECORD (can be NULL))
31 * 0x10: SAFEARRAYBOUNDS[0...]
45 #include "wine/debug.h"
48 WINE_DEFAULT_DEBUG_CHANNEL(ole
);
50 /************************************************************************
51 * SafeArray {OLEAUT32}
54 * The SafeArray data type provides the underlying interface for Ole
55 * Automations arrays, used for example to represent array types in
56 * Visual Basic(tm) and to gather user defined parameters for invocation through
57 * an IDispatch interface.
59 * Safe arrays provide bounds checking and automatically manage the data
60 * types they contain, for example handing reference counting and copying
61 * of interface pointers. User defined types can be stored in arrays
62 * using the IRecordInfo interface.
64 * There are two types of SafeArray, normal and vectors. Normal arrays can have
65 * multiple dimensions and the data for the array is allocated seperately from
66 * the array header. This is the most flexable type of array. Vectors, on the
67 * other hand, are fixed in size and consist of a single allocated block, and a
71 * The following types of data can be stored within a SafeArray.
73 *| VT_I1, VT_UI1, VT_I2, VT_UI2, VT_I4, VT_UI4, VT_I8, VT_UI8, VT_INT, VT_UINT,
74 *| VT_R4, VT_R8, VT_CY, VT_DECIMAL
76 *| VT_DISPATCH, VT_UNKNOWN, VT_RECORD
78 *| VT_VARIANT, VT_INT_PTR, VT_UINT_PTR, VT_BOOL, VT_ERROR, VT_DATE, VT_BSTR
85 /* Undocumented hidden space before the start of a SafeArray descriptor */
86 #define SAFEARRAY_HIDDEN_SIZE sizeof(GUID)
89 static inline LPVOID
SAFEARRAY_Malloc(ULONG ulSize
)
91 /* FIXME: Memory should be allocated and freed using a per-thread IMalloc
92 * instance returned from CoGetMalloc().
94 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, ulSize
);
98 static inline BOOL
SAFEARRAY_Free(LPVOID lpData
)
100 return HeapFree(GetProcessHeap(), 0, lpData
);
103 /* Get the size of a supported VT type (0 means unsupported) */
104 static DWORD
SAFEARRAY_GetVTSize(VARTYPE vt
)
109 case VT_UI1
: return sizeof(BYTE
);
112 case VT_UI2
: return sizeof(SHORT
);
116 case VT_ERROR
: return sizeof(LONG
);
119 case VT_UI8
: return sizeof(LONG64
);
121 case VT_UINT
: return sizeof(INT
);
123 case VT_UINT_PTR
: return sizeof(UINT_PTR
);
124 case VT_CY
: return sizeof(CY
);
125 case VT_DATE
: return sizeof(DATE
);
126 case VT_BSTR
: return sizeof(BSTR
);
127 case VT_DISPATCH
: return sizeof(LPDISPATCH
);
128 case VT_VARIANT
: return sizeof(VARIANT
);
129 case VT_UNKNOWN
: return sizeof(LPUNKNOWN
);
130 case VT_DECIMAL
: return sizeof(DECIMAL
);
131 /* Note: Return a non-zero size to indicate vt is valid. The actual size
132 * of a UDT is taken from the result of IRecordInfo_GetSize().
134 case VT_RECORD
: return 32;
139 /* Set the hidden data for an array */
140 static inline void SAFEARRAY_SetHiddenDWORD(SAFEARRAY
* psa
, DWORD dw
)
142 /* Implementation data is stored in the 4 bytes before the header */
143 LPDWORD lpDw
= (LPDWORD
)psa
;
147 /* Get the hidden data from an array */
148 static inline DWORD
SAFEARRAY_GetHiddenDWORD(SAFEARRAY
* psa
)
150 LPDWORD lpDw
= (LPDWORD
)psa
;
154 /* Get the number of cells in a SafeArray */
155 static ULONG
SAFEARRAY_GetCellCount(const SAFEARRAY
*psa
)
157 SAFEARRAYBOUND
* psab
= psa
->rgsabound
;
158 USHORT cCount
= psa
->cDims
;
159 ULONG ulNumCells
= 1;
163 /* This is a valid bordercase. See testcases. -Marcus */
164 if (!psab
->cElements
)
166 ulNumCells
*= psab
->cElements
;
172 /* Get the 0 based index of an index into a dimension */
173 static inline ULONG
SAFEARRAY_GetDimensionIndex(SAFEARRAYBOUND
*psab
, ULONG ulIndex
)
175 return ulIndex
- psab
->lLbound
;
178 /* Get the size of a dimension in cells */
179 static inline ULONG
SAFEARRAY_GetDimensionCells(SAFEARRAY
*psa
, ULONG ulDim
)
181 ULONG size
= psa
->rgsabound
[0].cElements
;
185 size
*= psa
->rgsabound
[ulDim
].cElements
;
191 /* Allocate a descriptor for an array */
192 static HRESULT
SAFEARRAY_AllocDescriptor(ULONG ulSize
, SAFEARRAY
**ppsaOut
)
194 *ppsaOut
= (SAFEARRAY
*)((char*)SAFEARRAY_Malloc(ulSize
+ SAFEARRAY_HIDDEN_SIZE
) + SAFEARRAY_HIDDEN_SIZE
);
202 /* Set the features of an array */
203 static void SAFEARRAY_SetFeatures(VARTYPE vt
, SAFEARRAY
*psa
)
205 /* Set the IID if we have one, otherwise set the type */
206 if (vt
== VT_DISPATCH
)
208 psa
->fFeatures
= FADF_HAVEIID
;
209 SafeArraySetIID(psa
, &IID_IDispatch
);
211 else if (vt
== VT_UNKNOWN
)
213 psa
->fFeatures
= FADF_HAVEIID
;
214 SafeArraySetIID(psa
, &IID_IUnknown
);
216 else if (vt
== VT_RECORD
)
217 psa
->fFeatures
= FADF_RECORD
;
220 psa
->fFeatures
= FADF_HAVEVARTYPE
;
221 SAFEARRAY_SetHiddenDWORD(psa
, vt
);
225 /* Create an array */
226 static SAFEARRAY
* SAFEARRAY_Create(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
, ULONG ulSize
)
228 SAFEARRAY
*psa
= NULL
;
233 if (SUCCEEDED(SafeArrayAllocDescriptorEx(vt
, cDims
, &psa
)))
237 case VT_BSTR
: psa
->fFeatures
|= FADF_BSTR
; break;
238 case VT_UNKNOWN
: psa
->fFeatures
|= FADF_UNKNOWN
; break;
239 case VT_DISPATCH
: psa
->fFeatures
|= FADF_DISPATCH
; break;
240 case VT_VARIANT
: psa
->fFeatures
|= FADF_VARIANT
; break;
243 memcpy(psa
->rgsabound
, rgsabound
, cDims
* sizeof(SAFEARRAYBOUND
));
246 psa
->cbElements
= ulSize
;
248 if (FAILED(SafeArrayAllocData(psa
)))
250 SafeArrayDestroyDescriptor(psa
);
257 /* Create an array as a vector */
258 static SAFEARRAY
* SAFEARRAY_CreateVector(VARTYPE vt
, LONG lLbound
, ULONG cElements
, ULONG ulSize
)
260 SAFEARRAY
*psa
= NULL
;
262 if (ulSize
|| (vt
== VT_RECORD
))
264 /* Allocate the header and data together */
265 if (SUCCEEDED(SAFEARRAY_AllocDescriptor(sizeof(SAFEARRAY
) + ulSize
* cElements
, &psa
)))
267 SAFEARRAY_SetFeatures(vt
, psa
);
270 psa
->fFeatures
|= FADF_CREATEVECTOR
;
271 psa
->pvData
= &psa
[1]; /* Data follows the header */
272 psa
->cbElements
= ulSize
;
273 psa
->rgsabound
[0].cElements
= cElements
;
274 psa
->rgsabound
[0].lLbound
= lLbound
;
278 case VT_BSTR
: psa
->fFeatures
|= FADF_BSTR
; break;
279 case VT_UNKNOWN
: psa
->fFeatures
|= FADF_UNKNOWN
; break;
280 case VT_DISPATCH
: psa
->fFeatures
|= FADF_DISPATCH
; break;
281 case VT_VARIANT
: psa
->fFeatures
|= FADF_VARIANT
; break;
288 /* Free data items in an array */
289 static HRESULT
SAFEARRAY_DestroyData(SAFEARRAY
*psa
, ULONG ulStartCell
)
291 if (psa
->pvData
&& !(psa
->fFeatures
& FADF_DATADELETED
))
293 ULONG ulCellCount
= SAFEARRAY_GetCellCount(psa
);
295 if (ulStartCell
> ulCellCount
) {
296 FIXME("unexpted ulcellcount %ld, start %ld\n",ulCellCount
,ulStartCell
);
300 ulCellCount
-= ulStartCell
;
302 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
304 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)psa
->pvData
+ ulStartCell
* psa
->cbElements
;
309 IUnknown_Release(*lpUnknown
);
313 else if (psa
->fFeatures
& (FADF_RECORD
))
315 IRecordInfo
*lpRecInfo
;
317 if (SUCCEEDED(SafeArrayGetRecordInfo(psa
, &lpRecInfo
)))
319 PBYTE pRecordData
= (PBYTE
)psa
->pvData
;
322 IRecordInfo_RecordClear(lpRecInfo
, pRecordData
);
323 pRecordData
+= psa
->cbElements
;
325 IRecordInfo_Release(lpRecInfo
);
328 else if (psa
->fFeatures
& FADF_BSTR
)
330 BSTR
* lpBstr
= (BSTR
*)psa
->pvData
+ ulStartCell
* psa
->cbElements
;
335 SysFreeString(*lpBstr
);
339 else if (psa
->fFeatures
& FADF_VARIANT
)
341 VARIANT
* lpVariant
= (VARIANT
*)psa
->pvData
+ ulStartCell
* psa
->cbElements
;
345 VariantClear(lpVariant
);
353 /* Copy data items from one array to another */
354 static HRESULT
SAFEARRAY_CopyData(SAFEARRAY
*psa
, SAFEARRAY
*dest
)
356 if (!psa
->pvData
|| !dest
->pvData
|| psa
->fFeatures
& FADF_DATADELETED
)
360 ULONG ulCellCount
= SAFEARRAY_GetCellCount(psa
);
362 dest
->fFeatures
= (dest
->fFeatures
& FADF_CREATEVECTOR
) |
363 (psa
->fFeatures
& ~(FADF_CREATEVECTOR
|FADF_DATADELETED
));
365 if (psa
->fFeatures
& FADF_VARIANT
)
367 VARIANT
* lpVariant
= (VARIANT
*)psa
->pvData
;
368 VARIANT
* lpDest
= (VARIANT
*)dest
->pvData
;
372 VariantCopy(lpDest
, lpVariant
);
377 else if (psa
->fFeatures
& FADF_BSTR
)
379 BSTR
* lpBstr
= (BSTR
*)psa
->pvData
;
380 BSTR
* lpDest
= (BSTR
*)dest
->pvData
;
386 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
388 return E_OUTOFMEMORY
;
398 /* Copy the data over */
399 memcpy(dest
->pvData
, psa
->pvData
, ulCellCount
* psa
->cbElements
);
401 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
403 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)dest
->pvData
;
408 IUnknown_AddRef(*lpUnknown
);
414 if (psa
->fFeatures
& FADF_RECORD
)
416 IRecordInfo
* pRecInfo
= NULL
;
418 SafeArrayGetRecordInfo(psa
, &pRecInfo
);
419 SafeArraySetRecordInfo(dest
, pRecInfo
);
423 /* Release because Get() adds a reference */
424 IRecordInfo_Release(pRecInfo
);
427 else if (psa
->fFeatures
& FADF_HAVEIID
)
430 SafeArrayGetIID(psa
, &guid
);
431 SafeArraySetIID(dest
, &guid
);
433 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
435 SAFEARRAY_SetHiddenDWORD(dest
, SAFEARRAY_GetHiddenDWORD(psa
));
441 /*************************************************************************
442 * SafeArrayAllocDescriptor (OLEAUT32.36)
444 * Allocate and initialise a descriptor for a SafeArray.
447 * cDims [I] Number of dimensions of the array
448 * ppsaOut [O] Destination for new descriptor
451 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
452 * Failure: An HRESULT error code indicating the error.
457 HRESULT WINAPI
SafeArrayAllocDescriptor(UINT cDims
, SAFEARRAY
**ppsaOut
)
461 TRACE("(%d,%p)\n", cDims
, ppsaOut
);
463 if (!cDims
|| cDims
>= 0x10000) /* Maximum 65535 dimensions */
469 /* We need enough space for the header and its bounds */
470 allocSize
= sizeof(SAFEARRAY
) + sizeof(SAFEARRAYBOUND
) * (cDims
- 1);
472 if (FAILED(SAFEARRAY_AllocDescriptor(allocSize
, ppsaOut
)))
475 (*ppsaOut
)->cDims
= cDims
;
477 TRACE("(%d): %lu bytes allocated for descriptor.\n", cDims
, allocSize
);
481 /*************************************************************************
482 * SafeArrayAllocDescriptorEx (OLEAUT32.41)
484 * Allocate and initialise a descriptor for a SafeArray of a given type.
487 * vt [I] The type of items to store in the array
488 * cDims [I] Number of dimensions of the array
489 * ppsaOut [O] Destination for new descriptor
492 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
493 * Failure: An HRESULT error code indicating the error.
496 * - This function does not chack that vt is an allowed VARTYPE.
497 * - Unlike SafeArrayAllocDescriptor(), vt is associated with the array.
500 HRESULT WINAPI
SafeArrayAllocDescriptorEx(VARTYPE vt
, UINT cDims
, SAFEARRAY
**ppsaOut
)
503 HRESULT hRet
= E_UNEXPECTED
;
505 TRACE("(%d->%s,%d,%p)\n", vt
, debugstr_vt(vt
), cDims
, ppsaOut
);
507 cbElements
= SAFEARRAY_GetVTSize(vt
);
509 WARN("Creating a descriptor with an invalid VARTYPE!\n");
511 hRet
= SafeArrayAllocDescriptor(cDims
, ppsaOut
);
515 SAFEARRAY_SetFeatures(vt
, *ppsaOut
);
516 (*ppsaOut
)->cbElements
= cbElements
;
521 /*************************************************************************
522 * SafeArrayAllocData (OLEAUT32.37)
524 * Allocate the data area of a SafeArray.
527 * psa [I] SafeArray to allocate the data area of.
530 * Success: S_OK. The data area is allocated and initialised.
531 * Failure: An HRESULT error code indicating the error.
536 HRESULT WINAPI
SafeArrayAllocData(SAFEARRAY
*psa
)
538 HRESULT hRet
= E_INVALIDARG
;
540 TRACE("(%p)\n", psa
);
544 ULONG ulSize
= SAFEARRAY_GetCellCount(psa
);
546 hRet
= E_OUTOFMEMORY
;
550 psa
->pvData
= SAFEARRAY_Malloc(ulSize
* psa
->cbElements
);
555 TRACE("%lu bytes allocated for data at %p (%lu objects).\n",
556 ulSize
* psa
->cbElements
, psa
->pvData
, ulSize
);
563 /*************************************************************************
564 * SafeArrayCreate (OLEAUT32.15)
566 * Create a new SafeArray.
569 * vt [I] Type to store in the safe array
570 * cDims [I] Number of array dimensions
571 * rgsabound [I] Bounds of the array dimensions
574 * Success: A pointer to a new array object.
575 * Failure: NULL, if any parameter is invalid or memory allocation fails.
578 * Win32 allows arrays with 0 sized dimensions. This bug is not reproduced
579 * in the Wine implementation.
582 SAFEARRAY
* WINAPI
SafeArrayCreate(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
)
584 TRACE("(%d->%s,%d,%p)\n", vt
, debugstr_vt(vt
), cDims
, rgsabound
);
589 return SAFEARRAY_Create(vt
, cDims
, rgsabound
, 0);
592 /*************************************************************************
593 * SafeArrayCreateEx (OLEAUT32.15)
595 * Create a new SafeArray.
598 * vt [I] Type to store in the safe array
599 * cDims [I] Number of array dimensions
600 * rgsabound [I] Bounds of the array dimensions
601 * pvExtra [I] Extra data
604 * Success: A pointer to a new array object.
605 * Failure: NULL, if any parameter is invalid or memory allocation fails.
610 SAFEARRAY
* WINAPI
SafeArrayCreateEx(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
, LPVOID pvExtra
)
613 IRecordInfo
* iRecInfo
= (IRecordInfo
*)pvExtra
;
616 TRACE("(%d->%s,%d,%p,%p)\n", vt
, debugstr_vt(vt
), cDims
, rgsabound
, pvExtra
);
622 IRecordInfo_GetSize(iRecInfo
, &ulSize
);
624 psa
= SAFEARRAY_Create(vt
, cDims
, rgsabound
, ulSize
);
631 SafeArraySetRecordInfo(psa
, pvExtra
);
635 SafeArraySetIID(psa
, pvExtra
);
642 /************************************************************************
643 * SafeArrayCreateVector (OLEAUT32.411)
645 * Create a one dimensional, contigous SafeArray.
648 * vt [I] Type to store in the safe array
649 * lLbound [I] Lower bound of the array
650 * cElements [I] Number of elements in the array
653 * Success: A pointer to a new array object.
654 * Failure: NULL, if any parameter is invalid or memory allocation fails.
659 SAFEARRAY
* WINAPI
SafeArrayCreateVector(VARTYPE vt
, LONG lLbound
, ULONG cElements
)
661 TRACE("(%d->%s,%ld,%ld\n", vt
, debugstr_vt(vt
), lLbound
, cElements
);
666 return SAFEARRAY_CreateVector(vt
, lLbound
, cElements
, SAFEARRAY_GetVTSize(vt
));
669 /************************************************************************
670 * SafeArrayCreateVectorEx (OLEAUT32.411)
672 * Create a one dimensional, contigous SafeArray.
675 * vt [I] Type to store in the safe array
676 * lLbound [I] Lower bound of the array
677 * cElements [I] Number of elements in the array
678 * pvExtra [I] Extra data
681 * Success: A pointer to a new array object.
682 * Failure: NULL, if any parameter is invalid or memory allocation fails.
687 SAFEARRAY
* WINAPI
SafeArrayCreateVectorEx(VARTYPE vt
, LONG lLbound
, ULONG cElements
, LPVOID pvExtra
)
690 IRecordInfo
* iRecInfo
= (IRecordInfo
*)pvExtra
;
693 TRACE("(%d->%s,%ld,%ld,%p\n", vt
, debugstr_vt(vt
), lLbound
, cElements
, pvExtra
);
699 IRecordInfo_GetSize(iRecInfo
, &ulSize
);
702 ulSize
= SAFEARRAY_GetVTSize(vt
);
704 psa
= SAFEARRAY_CreateVector(vt
, lLbound
, cElements
, ulSize
);
711 SafeArraySetRecordInfo(psa
, iRecInfo
);
715 SafeArraySetIID(psa
, pvExtra
);
722 /*************************************************************************
723 * SafeArrayDestroyDescriptor (OLEAUT32.38)
725 * Destroy a SafeArray.
728 * psa [I] SafeArray to destroy.
731 * Success: S_OK. The resources used by the array are freed.
732 * Failure: An HRESULT error code indicating the error.
737 HRESULT WINAPI
SafeArrayDestroyDescriptor(SAFEARRAY
*psa
)
739 TRACE("(%p)\n", psa
);
743 LPVOID lpv
= (char*)psa
- SAFEARRAY_HIDDEN_SIZE
;
746 return DISP_E_ARRAYISLOCKED
; /* Can't destroy a locked array */
748 if (psa
->fFeatures
& FADF_RECORD
)
749 SafeArraySetRecordInfo(psa
, NULL
);
751 if (psa
->fFeatures
& FADF_CREATEVECTOR
&&
752 !(psa
->fFeatures
& FADF_DATADELETED
))
753 SAFEARRAY_DestroyData(psa
, 0); /* Data not previously deleted */
755 if (!SAFEARRAY_Free(lpv
))
761 /*************************************************************************
762 * SafeArrayLock (OLEAUT32.21)
764 * Increment the lock counter of a SafeArray.
767 * psa [O] SafeArray to lock
770 * Success: S_OK. The array lock is incremented.
771 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if too many locks
772 * are held on the array at once.
775 * In Win32 these locks are not thread safe.
778 HRESULT WINAPI
SafeArrayLock(SAFEARRAY
*psa
)
782 TRACE("(%p)\n", psa
);
787 ulLocks
= InterlockedIncrement(&psa
->cLocks
);
789 if (ulLocks
> 0xffff) /* Maximum of 16384 locks at a time */
791 WARN("Out of locks!\n");
792 InterlockedDecrement(&psa
->cLocks
);
798 /*************************************************************************
799 * SafeArrayUnlock (OLEAUT32.22)
801 * Decrement the lock counter of a SafeArray.
804 * psa [O] SafeArray to unlock
807 * Success: S_OK. The array lock is decremented.
808 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if no locks are
814 HRESULT WINAPI
SafeArrayUnlock(SAFEARRAY
*psa
)
816 TRACE("(%p)\n", psa
);
821 if ((LONG
)InterlockedDecrement(&psa
->cLocks
) < 0)
823 WARN("Unlocked but no lock held!\n");
824 InterlockedIncrement(&psa
->cLocks
);
830 /*************************************************************************
831 * SafeArrayPutElement (OLEAUT32.26)
833 * Put an item into a SafeArray.
836 * psa [I] SafeArray to insert into
837 * rgIndices [I] Indices to insert at
838 * pvData [I] Data to insert
841 * Success: S_OK. The item is inserted
842 * Failure: An HRESULT error code indicating the error.
847 HRESULT WINAPI
SafeArrayPutElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
851 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
853 if (!psa
|| !rgIndices
)
858 ERR("Invalid pvData would crash under Win32!\n");
862 hRet
= SafeArrayLock(psa
);
868 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvDest
);
872 if (psa
->fFeatures
& FADF_VARIANT
)
874 VARIANT
* lpVariant
= (VARIANT
*)pvData
;
875 VARIANT
* lpDest
= (VARIANT
*)lpvDest
;
877 VariantClear(lpDest
);
878 VariantCopy(lpDest
, lpVariant
);
880 else if (psa
->fFeatures
& FADF_BSTR
)
882 BSTR lpBstr
= (BSTR
)pvData
;
883 BSTR
* lpDest
= (BSTR
*)lpvDest
;
886 SysFreeString(*lpDest
);
890 *lpDest
= SysAllocStringByteLen((char*)lpBstr
, SysStringByteLen(lpBstr
));
892 hRet
= E_OUTOFMEMORY
;
899 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
901 LPUNKNOWN lpUnknown
= (LPUNKNOWN
)pvData
;
902 LPUNKNOWN
*lpDest
= (LPUNKNOWN
*)lpvDest
;
905 IUnknown_AddRef(lpUnknown
);
907 IUnknown_Release(*lpDest
);
910 /* Copy the data over */
911 memcpy(lpvDest
, pvData
, psa
->cbElements
);
915 SafeArrayUnlock(psa
);
921 /*************************************************************************
922 * SafeArrayGetElement (OLEAUT32.25)
924 * Get an item from a SafeArray.
927 * psa [I] SafeArray to get from
928 * rgIndices [I] Indices to get from
929 * pvData [O] Destination for data
932 * Success: S_OK. The item data is returned in pvData.
933 * Failure: An HRESULT error code indicating the error.
938 HRESULT WINAPI
SafeArrayGetElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
942 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
944 if (!psa
|| !rgIndices
|| !pvData
)
947 hRet
= SafeArrayLock(psa
);
953 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvSrc
);
957 if (psa
->fFeatures
& FADF_VARIANT
)
959 VARIANT
* lpVariant
= (VARIANT
*)lpvSrc
;
960 VARIANT
* lpDest
= (VARIANT
*)pvData
;
962 VariantCopy(lpDest
, lpVariant
);
964 else if (psa
->fFeatures
& FADF_BSTR
)
966 BSTR
* lpBstr
= (BSTR
*)lpvSrc
;
967 BSTR
* lpDest
= (BSTR
*)pvData
;
971 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
973 hRet
= E_OUTOFMEMORY
;
980 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
982 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)lpvSrc
;
985 IUnknown_AddRef(*lpUnknown
);
987 /* Copy the data over */
988 memcpy(pvData
, lpvSrc
, psa
->cbElements
);
991 SafeArrayUnlock(psa
);
996 /*************************************************************************
997 * SafeArrayGetUBound (OLEAUT32.19)
999 * Get the upper bound for a given SafeArray dimension
1002 * psa [I] Array to get dimension upper bound from
1003 * nDim [I] The dimension number to get the upper bound of
1004 * plUbound [O] Destination for the upper bound
1007 * Success: S_OK. plUbound contains the dimensions upper bound.
1008 * Failure: An HRESULT error code indicating the error.
1013 HRESULT WINAPI
SafeArrayGetUBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plUbound
)
1015 TRACE("(%p,%d,%p)\n", psa
, nDim
, plUbound
);
1017 if (!psa
|| !plUbound
)
1018 return E_INVALIDARG
;
1020 if(!nDim
|| nDim
> psa
->cDims
)
1021 return DISP_E_BADINDEX
;
1023 *plUbound
= psa
->rgsabound
[nDim
- 1].lLbound
+
1024 psa
->rgsabound
[nDim
- 1].cElements
- 1;
1029 /*************************************************************************
1030 * SafeArrayGetLBound (OLEAUT32.20)
1032 * Get the lower bound for a given SafeArray dimension
1035 * psa [I] Array to get dimension lower bound from
1036 * nDim [I] The dimension number to get the lowe bound of
1037 * plLbound [O] Destination for the lower bound
1040 * Success: S_OK. plUbound contains the dimensions lower bound.
1041 * Failure: An HRESULT error code indicating the error.
1046 HRESULT WINAPI
SafeArrayGetLBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plLbound
)
1048 TRACE("(%p,%d,%p)\n", psa
, nDim
, plLbound
);
1050 if (!psa
|| !plLbound
)
1051 return E_INVALIDARG
;
1053 if(!nDim
|| nDim
> psa
->cDims
)
1054 return DISP_E_BADINDEX
;
1056 *plLbound
= psa
->rgsabound
[nDim
- 1].lLbound
;
1060 /*************************************************************************
1061 * SafeArrayGetDim (OLEAUT32.17)
1063 * Get the number of dimensions in a SafeArray.
1066 * psa [I] Array to get the dimensions of
1069 * The number of array dimensions in psa, or 0 if psa is NULL.
1074 UINT WINAPI
SafeArrayGetDim(SAFEARRAY
*psa
)
1076 TRACE("(%p) returning %ld\n", psa
, psa
? psa
->cDims
: 0ul);
1077 return psa
? psa
->cDims
: 0;
1080 /*************************************************************************
1081 * SafeArrayGetElemsize (OLEAUT32.18)
1083 * Get the size of an element in a SafeArray.
1086 * psa [I] Array to get the element size from
1089 * The size of a single element in psa, or 0 if psa is NULL.
1094 UINT WINAPI
SafeArrayGetElemsize(SAFEARRAY
*psa
)
1096 TRACE("(%p) returning %ld\n", psa
, psa
? psa
->cbElements
: 0ul);
1097 return psa
? psa
->cbElements
: 0;
1100 /*************************************************************************
1101 * SafeArrayAccessData (OLEAUT32.23)
1103 * Lock a SafeArray and return a pointer to its data.
1106 * psa [I] Array to get the data pointer from
1107 * ppvData [O] Destination for the arrays data pointer
1110 * Success: S_OK. ppvData contains the arrays data pointer, and the array
1112 * Failure: An HRESULT error code indicating the error.
1117 HRESULT WINAPI
SafeArrayAccessData(SAFEARRAY
*psa
, void **ppvData
)
1119 TRACE("(%p,%p)\n", psa
, ppvData
);
1121 if(!psa
|| !ppvData
)
1122 return E_INVALIDARG
;
1124 if (SUCCEEDED(SafeArrayLock(psa
)))
1126 *ppvData
= psa
->pvData
;
1130 return E_UNEXPECTED
;
1134 /*************************************************************************
1135 * SafeArrayUnaccessData (OLEAUT32.24)
1137 * Unlock a SafeArray after accessing its data.
1140 * psa [I] Array to unlock
1143 * Success: S_OK. The array is unlocked.
1144 * Failure: An HRESULT error code indicating the error.
1149 HRESULT WINAPI
SafeArrayUnaccessData(SAFEARRAY
*psa
)
1151 TRACE("(%p)\n", psa
);
1152 return SafeArrayUnlock(psa
);
1155 /************************************************************************
1156 * SafeArrayPtrOfIndex (OLEAUT32.148)
1158 * Get the address of an item in a SafeArray.
1161 * psa [I] Array to get the items address from
1162 * rgIndices [I] Index of the item in the array
1163 * ppvData [O] Destination for item address
1166 * Success: S_OK. ppvData contains a pointer to the item.
1167 * Failure: An HRESULT error code indicating the error.
1170 * This function does not lock the array.
1175 HRESULT WINAPI
SafeArrayPtrOfIndex(SAFEARRAY
*psa
, LONG
*rgIndices
, void **ppvData
)
1178 ULONG cell
= 0, dimensionSize
= 1;
1179 SAFEARRAYBOUND
* psab
;
1182 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, ppvData
);
1184 /* The general formula for locating the cell number of an entry in an n
1185 * dimensional array (where cn = coordinate in dimension dn) is:
1187 * c1 + c2 * sizeof(d1) + c3 * sizeof(d2) ... + cn * sizeof(c(n-1))
1189 * We calculate the size of the last dimension at each step through the
1190 * dimensions to avoid recursing to calculate the last dimensions size.
1192 if (!psa
|| !rgIndices
|| !ppvData
)
1193 return E_INVALIDARG
;
1195 psab
= psa
->rgsabound
;
1198 if (c1
< psab
->lLbound
|| c1
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1199 return DISP_E_BADINDEX
; /* Initial index out of bounds */
1201 for (dim
= 1; dim
< psa
->cDims
; dim
++)
1203 dimensionSize
*= psab
->cElements
;
1207 if (!psab
->cElements
||
1208 *rgIndices
< psab
->lLbound
||
1209 *rgIndices
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1210 return DISP_E_BADINDEX
; /* Index out of bounds */
1212 cell
+= (*rgIndices
- psab
->lLbound
) * dimensionSize
;
1216 cell
+= (c1
- psa
->rgsabound
[0].lLbound
);
1218 *ppvData
= (char*)psa
->pvData
+ cell
* psa
->cbElements
;
1222 /************************************************************************
1223 * SafeArrayDestroyData (OLEAUT32.39)
1225 * Destroy the data associated with a SafeArray.
1228 * psa [I] Array to delete the data from
1231 * Success: S_OK. All items and the item data are freed.
1232 * Failure: An HRESULT error code indicating the error.
1237 HRESULT WINAPI
SafeArrayDestroyData(SAFEARRAY
*psa
)
1239 TRACE("(%p)\n", psa
);
1242 return E_INVALIDARG
;
1245 return DISP_E_ARRAYISLOCKED
; /* Cant delete a locked array */
1249 /* Delete the actual item data */
1250 if (FAILED(SAFEARRAY_DestroyData(psa
, 0)))
1251 return E_UNEXPECTED
;
1253 /* If this is not a vector, free the data memory block */
1254 if (!(psa
->fFeatures
& FADF_CREATEVECTOR
))
1256 if (!SAFEARRAY_Free(psa
->pvData
))
1257 return E_UNEXPECTED
;
1261 psa
->fFeatures
|= FADF_DATADELETED
; /* Mark the data deleted */
1267 /************************************************************************
1268 * SafeArrayCopyData (OLEAUT32.412)
1270 * Copy all data from one SafeArray to another.
1273 * psaSource [I] Source for copy
1274 * psaTarget [O] Destination for copy
1277 * Success: S_OK. psaTarget contains a copy of psaSource.
1278 * Failure: An HRESULT error code indicating the error.
1281 * The two arrays must have the same number of dimensions and elements.
1286 HRESULT WINAPI
SafeArrayCopyData(SAFEARRAY
*psaSource
, SAFEARRAY
*psaTarget
)
1290 TRACE("(%p,%p)\n", psaSource
, psaTarget
);
1292 if (!psaSource
|| !psaTarget
||
1293 psaSource
->cDims
!= psaTarget
->cDims
||
1294 psaSource
->cbElements
!= psaTarget
->cbElements
)
1295 return E_INVALIDARG
;
1297 /* Each dimension must be the same size */
1298 for (dim
= psaSource
->cDims
- 1; dim
>= 0 ; dim
--)
1299 if (psaSource
->rgsabound
[dim
].cElements
!=
1300 psaTarget
->rgsabound
[dim
].cElements
)
1301 return E_INVALIDARG
;
1303 if (SUCCEEDED(SAFEARRAY_DestroyData(psaTarget
, 0)) &&
1304 SUCCEEDED(SAFEARRAY_CopyData(psaSource
, psaTarget
)))
1306 return E_UNEXPECTED
;
1309 /************************************************************************
1310 * SafeArrayDestroy (OLEAUT32.16)
1312 * Destroy a SafeArray.
1315 * psa [I] Array to destroy
1318 * Success: S_OK. All resources used by the array are freed.
1319 * Failure: An HRESULT error code indicating the error.
1324 HRESULT WINAPI
SafeArrayDestroy(SAFEARRAY
*psa
)
1326 TRACE("(%p)\n", psa
);
1329 return E_INVALIDARG
;
1332 return DISP_E_ARRAYISLOCKED
;
1334 /* Native doesn't check to see if the free succeeds */
1335 SafeArrayDestroyData(psa
);
1336 SafeArrayDestroyDescriptor(psa
);
1340 /************************************************************************
1341 * SafeArrayCopy (OLEAUT32.27)
1343 * Make a duplicate of a SafeArray.
1346 * psa [I] Source for copy
1347 * ppsaOut [O] Destination for new copy
1350 * Success: S_OK. ppsaOut contains a copy of the array.
1351 * Failure: An HRESULT error code indicating the error.
1356 HRESULT WINAPI
SafeArrayCopy(SAFEARRAY
*psa
, SAFEARRAY
**ppsaOut
)
1360 TRACE("(%p,%p)\n", psa
, ppsaOut
);
1363 return E_INVALIDARG
;
1368 return S_OK
; /* Handles copying of NULL arrays */
1370 if (psa
->fFeatures
& (FADF_RECORD
|FADF_HAVEIID
|FADF_HAVEVARTYPE
))
1373 if (FAILED(SafeArrayGetVartype(psa
, &vt
)))
1374 hRet
= E_UNEXPECTED
;
1376 hRet
= SafeArrayAllocDescriptorEx(vt
, psa
->cDims
, ppsaOut
);
1380 hRet
= SafeArrayAllocDescriptor(psa
->cDims
, ppsaOut
);
1381 if (SUCCEEDED(hRet
))
1383 (*ppsaOut
)->fFeatures
= psa
->fFeatures
& ~FADF_CREATEVECTOR
;
1384 (*ppsaOut
)->cbElements
= psa
->cbElements
;
1388 if (SUCCEEDED(hRet
))
1390 /* Copy dimension bounds */
1391 memcpy((*ppsaOut
)->rgsabound
, psa
->rgsabound
, psa
->cDims
* sizeof(SAFEARRAYBOUND
));
1393 (*ppsaOut
)->pvData
= SAFEARRAY_Malloc(SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
);
1395 if ((*ppsaOut
)->pvData
)
1397 hRet
= SAFEARRAY_CopyData(psa
, *ppsaOut
);
1399 if (SUCCEEDED(hRet
))
1402 SAFEARRAY_Free((*ppsaOut
)->pvData
);
1404 SafeArrayDestroyDescriptor(*ppsaOut
);
1410 /************************************************************************
1411 * SafeArrayRedim (OLEAUT32.40)
1413 * Changes the characteristics of the last dimension of a SafeArray
1416 * psa [I] Array to change
1417 * psabound [I] New bound details for the last dimension
1420 * Success: S_OK. psa is updated to reflect the new bounds.
1421 * Failure: An HRESULT error code indicating the error.
1426 HRESULT WINAPI
SafeArrayRedim(SAFEARRAY
*psa
, SAFEARRAYBOUND
*psabound
)
1428 SAFEARRAYBOUND
*oldBounds
;
1430 TRACE("(%p,%p)\n", psa
, psabound
);
1432 if (!psa
|| psa
->fFeatures
& FADF_FIXEDSIZE
|| !psabound
)
1433 return E_INVALIDARG
;
1435 if (psa
->cLocks
> 0)
1436 return DISP_E_ARRAYISLOCKED
;
1438 if (FAILED(SafeArrayLock(psa
)))
1439 return E_UNEXPECTED
;
1441 oldBounds
= &psa
->rgsabound
[psa
->cDims
- 1];
1442 oldBounds
->lLbound
= psabound
->lLbound
;
1444 if (psabound
->cElements
!= oldBounds
->cElements
)
1446 if (psabound
->cElements
< oldBounds
->cElements
)
1448 /* Shorten the final dimension. */
1449 ULONG ulStartCell
= psa
->cDims
== 1 ? 0 : SAFEARRAY_GetDimensionCells(psa
, psa
->cDims
- 1);
1451 ulStartCell
+= psabound
->cElements
;
1452 SAFEARRAY_DestroyData(psa
, ulStartCell
);
1456 /* Lengthen the final dimension */
1457 ULONG ulOldSize
, ulNewSize
;
1460 ulOldSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1462 ulNewSize
= (ulOldSize
/ oldBounds
->cElements
) * psabound
->cElements
;
1464 int oldelems
= oldBounds
->cElements
;
1465 oldBounds
->cElements
= psabound
->cElements
;
1466 ulNewSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1467 oldBounds
->cElements
= oldelems
;
1470 if (!(pvNewData
= SAFEARRAY_Malloc(ulNewSize
)))
1472 SafeArrayUnlock(psa
);
1473 return E_UNEXPECTED
;
1476 memcpy(pvNewData
, psa
->pvData
, ulOldSize
);
1477 SAFEARRAY_Free(psa
->pvData
);
1478 psa
->pvData
= pvNewData
;
1480 oldBounds
->cElements
= psabound
->cElements
;
1483 SafeArrayUnlock(psa
);
1487 /************************************************************************
1488 * SafeArrayGetVartype (OLEAUT32.77)
1490 * Get the type of the items in a SafeArray.
1493 * psa [I] Array to get the type from
1494 * pvt [O] Destination for the type
1497 * Success: S_OK. pvt contains the type of the items.
1498 * Failure: An HRESULT error code indicating the error.
1503 HRESULT WINAPI
SafeArrayGetVartype(SAFEARRAY
* psa
, VARTYPE
* pvt
)
1505 TRACE("(%p,%p)\n", psa
, pvt
);
1508 return E_INVALIDARG
;
1510 if (psa
->fFeatures
& FADF_RECORD
)
1512 else if (psa
->fFeatures
& FADF_HAVEIID
)
1514 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
1516 VARTYPE vt
= SAFEARRAY_GetHiddenDWORD(psa
);
1520 return E_INVALIDARG
;
1525 /************************************************************************
1526 * SafeArraySetRecordInfo (OLEAUT32.@)
1528 * Set the record info for a SafeArray.
1531 * psa [I] Array to set the record info for
1532 * pRinfo [I] Record info
1535 * Success: S_OK. The record info is stored with the array.
1536 * Failure: An HRESULT error code indicating the error.
1541 HRESULT WINAPI
SafeArraySetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
*pRinfo
)
1543 IRecordInfo
** dest
= (IRecordInfo
**)psa
;
1545 TRACE("(%p,%p)\n", psa
, pRinfo
);
1547 if (!psa
|| !(psa
->fFeatures
& FADF_RECORD
))
1548 return E_INVALIDARG
;
1551 IRecordInfo_AddRef(pRinfo
);
1554 IRecordInfo_Release(dest
[-1]);
1560 /************************************************************************
1561 * SafeArrayGetRecordInfo (OLEAUT32.@)
1563 * Get the record info from a SafeArray.
1566 * psa [I] Array to get the record info from
1567 * pRinfo [O] Destination for the record info
1570 * Success: S_OK. pRinfo contains the record info, or NULL if there was none.
1571 * Failure: An HRESULT error code indicating the error.
1576 HRESULT WINAPI
SafeArrayGetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
**pRinfo
)
1578 IRecordInfo
** src
= (IRecordInfo
**)psa
;
1580 TRACE("(%p,%p)\n", psa
, pRinfo
);
1582 if (!psa
|| !pRinfo
|| !(psa
->fFeatures
& FADF_RECORD
))
1583 return E_INVALIDARG
;
1588 IRecordInfo_AddRef(*pRinfo
);
1592 /************************************************************************
1593 * SafeArraySetIID (OLEAUT32.@)
1595 * Set the IID for a SafeArray.
1598 * psa [I] Array to set the IID from
1602 * Success: S_OK. The IID is stored with the array
1603 * Failure: An HRESULT error code indicating the error.
1608 HRESULT WINAPI
SafeArraySetIID(SAFEARRAY
*psa
, REFGUID guid
)
1610 GUID
* dest
= (GUID
*)psa
;
1612 TRACE("(%p,%s)\n", psa
, debugstr_guid(guid
));
1614 if (!psa
|| !guid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1615 return E_INVALIDARG
;
1621 /************************************************************************
1622 * SafeArrayGetIID (OLEAUT32.@)
1624 * Get the IID from a SafeArray.
1627 * psa [I] Array to get the ID from
1628 * pGuid [O] Destination for the IID
1631 * Success: S_OK. pRinfo contains the IID, or NULL if there was none.
1632 * Failure: An HRESULT error code indicating the error.
1637 HRESULT WINAPI
SafeArrayGetIID(SAFEARRAY
*psa
, GUID
*pGuid
)
1639 GUID
* src
= (GUID
*)psa
;
1641 TRACE("(%p,%p)\n", psa
, pGuid
);
1643 if (!psa
|| !pGuid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1644 return E_INVALIDARG
;
1650 /************************************************************************
1651 * VectorFromBstr (OLEAUT32.@)
1653 * Create a SafeArray Vector from the bytes of a BSTR.
1656 * bstr [I] String to get bytes from
1657 * ppsa [O] Destination for the array
1660 * Success: S_OK. ppsa contains the strings bytes as a VT_UI1 array.
1661 * Failure: An HRESULT error code indicating the error.
1666 HRESULT WINAPI
VectorFromBstr(BSTR bstr
, SAFEARRAY
**ppsa
)
1670 TRACE("(%p,%p)\n", bstr
, ppsa
);
1673 return E_INVALIDARG
;
1676 sab
.cElements
= SysStringByteLen(bstr
);
1678 *ppsa
= SAFEARRAY_Create(VT_UI1
, 1, &sab
, 0);
1682 memcpy((*ppsa
)->pvData
, bstr
, sab
.cElements
);
1685 return E_OUTOFMEMORY
;
1688 /************************************************************************
1689 * BstrFromVector (OLEAUT32.@)
1691 * Create a BSTR from a SafeArray.
1694 * psa [I] Source array
1695 * pbstr [O] Destination for output BSTR
1698 * Success: S_OK. pbstr contains the arrays data.
1699 * Failure: An HRESULT error code indicating the error.
1702 * psa must be a 1 dimensional array of a 1 byte type.
1707 HRESULT WINAPI
BstrFromVector(SAFEARRAY
*psa
, BSTR
*pbstr
)
1709 TRACE("(%p,%p)\n", psa
, pbstr
);
1712 return E_INVALIDARG
;
1716 if (!psa
|| psa
->cbElements
!= 1 || psa
->cDims
!= 1)
1717 return E_INVALIDARG
;
1719 *pbstr
= SysAllocStringByteLen(psa
->pvData
, psa
->rgsabound
[0].cElements
);
1721 return E_OUTOFMEMORY
;