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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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...]
46 #include "wine/debug.h"
48 WINE_DEFAULT_DEBUG_CHANNEL(variant
);
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 separately from
66 * the array header. This is the most flexible 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 const 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 /* Allocate a descriptor for an array */
173 static HRESULT
SAFEARRAY_AllocDescriptor(ULONG ulSize
, SAFEARRAY
**ppsaOut
)
175 *ppsaOut
= (SAFEARRAY
*)((char*)SAFEARRAY_Malloc(ulSize
+ SAFEARRAY_HIDDEN_SIZE
) + SAFEARRAY_HIDDEN_SIZE
);
183 /* Set the features of an array */
184 static void SAFEARRAY_SetFeatures(VARTYPE vt
, SAFEARRAY
*psa
)
186 /* Set the IID if we have one, otherwise set the type */
187 if (vt
== VT_DISPATCH
)
189 psa
->fFeatures
= FADF_HAVEIID
;
190 SafeArraySetIID(psa
, &IID_IDispatch
);
192 else if (vt
== VT_UNKNOWN
)
194 psa
->fFeatures
= FADF_HAVEIID
;
195 SafeArraySetIID(psa
, &IID_IUnknown
);
197 else if (vt
== VT_RECORD
)
198 psa
->fFeatures
= FADF_RECORD
;
201 psa
->fFeatures
= FADF_HAVEVARTYPE
;
202 SAFEARRAY_SetHiddenDWORD(psa
, vt
);
206 /* Create an array */
207 static SAFEARRAY
* SAFEARRAY_Create(VARTYPE vt
, UINT cDims
, const SAFEARRAYBOUND
*rgsabound
, ULONG ulSize
)
209 SAFEARRAY
*psa
= NULL
;
215 if (SUCCEEDED(SafeArrayAllocDescriptorEx(vt
, cDims
, &psa
)))
219 case VT_BSTR
: psa
->fFeatures
|= FADF_BSTR
; break;
220 case VT_UNKNOWN
: psa
->fFeatures
|= FADF_UNKNOWN
; break;
221 case VT_DISPATCH
: psa
->fFeatures
|= FADF_DISPATCH
; break;
222 case VT_VARIANT
: psa
->fFeatures
|= FADF_VARIANT
; break;
225 for (i
= 0; i
< cDims
; i
++)
226 memcpy(psa
->rgsabound
+ i
, rgsabound
+ cDims
- 1 - i
, sizeof(SAFEARRAYBOUND
));
229 psa
->cbElements
= ulSize
;
231 if (!psa
->cbElements
|| FAILED(SafeArrayAllocData(psa
)))
233 SafeArrayDestroyDescriptor(psa
);
240 /* Create an array as a vector */
241 static SAFEARRAY
* SAFEARRAY_CreateVector(VARTYPE vt
, LONG lLbound
, ULONG cElements
, ULONG ulSize
)
243 SAFEARRAY
*psa
= NULL
;
245 if (ulSize
|| (vt
== VT_RECORD
))
247 /* Allocate the header and data together */
248 if (SUCCEEDED(SAFEARRAY_AllocDescriptor(sizeof(SAFEARRAY
) + ulSize
* cElements
, &psa
)))
250 SAFEARRAY_SetFeatures(vt
, psa
);
253 psa
->fFeatures
|= FADF_CREATEVECTOR
;
254 psa
->pvData
= &psa
[1]; /* Data follows the header */
255 psa
->cbElements
= ulSize
;
256 psa
->rgsabound
[0].cElements
= cElements
;
257 psa
->rgsabound
[0].lLbound
= lLbound
;
261 case VT_BSTR
: psa
->fFeatures
|= FADF_BSTR
; break;
262 case VT_UNKNOWN
: psa
->fFeatures
|= FADF_UNKNOWN
; break;
263 case VT_DISPATCH
: psa
->fFeatures
|= FADF_DISPATCH
; break;
264 case VT_VARIANT
: psa
->fFeatures
|= FADF_VARIANT
; break;
271 /* Free data items in an array */
272 static HRESULT
SAFEARRAY_DestroyData(SAFEARRAY
*psa
, ULONG ulStartCell
)
274 if (psa
->pvData
&& !(psa
->fFeatures
& FADF_DATADELETED
))
276 ULONG ulCellCount
= SAFEARRAY_GetCellCount(psa
);
278 if (ulStartCell
> ulCellCount
) {
279 FIXME("unexpted ulcellcount %d, start %d\n",ulCellCount
,ulStartCell
);
283 ulCellCount
-= ulStartCell
;
285 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
287 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)psa
->pvData
+ ulStartCell
;
292 IUnknown_Release(*lpUnknown
);
296 else if (psa
->fFeatures
& (FADF_RECORD
))
298 IRecordInfo
*lpRecInfo
;
300 if (SUCCEEDED(SafeArrayGetRecordInfo(psa
, &lpRecInfo
)))
302 PBYTE pRecordData
= (PBYTE
)psa
->pvData
;
305 IRecordInfo_RecordClear(lpRecInfo
, pRecordData
);
306 pRecordData
+= psa
->cbElements
;
308 IRecordInfo_Release(lpRecInfo
);
311 else if (psa
->fFeatures
& FADF_BSTR
)
313 BSTR
* lpBstr
= (BSTR
*)psa
->pvData
+ ulStartCell
;
317 SysFreeString(*lpBstr
);
321 else if (psa
->fFeatures
& FADF_VARIANT
)
323 VARIANT
* lpVariant
= (VARIANT
*)psa
->pvData
+ ulStartCell
;
327 HRESULT hRet
= VariantClear(lpVariant
);
329 if (FAILED(hRet
)) FIXME("VariantClear of element failed!\n");
337 /* Copy data items from one array to another */
338 static HRESULT
SAFEARRAY_CopyData(SAFEARRAY
*psa
, SAFEARRAY
*dest
)
342 else if (!dest
->pvData
|| psa
->fFeatures
& FADF_DATADELETED
)
346 ULONG ulCellCount
= SAFEARRAY_GetCellCount(psa
);
348 dest
->fFeatures
= (dest
->fFeatures
& FADF_CREATEVECTOR
) |
349 (psa
->fFeatures
& ~(FADF_CREATEVECTOR
|FADF_DATADELETED
));
351 if (psa
->fFeatures
& FADF_VARIANT
)
353 VARIANT
* lpVariant
= (VARIANT
*)psa
->pvData
;
354 VARIANT
* lpDest
= (VARIANT
*)dest
->pvData
;
360 hRet
= VariantCopy(lpDest
, lpVariant
);
361 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%x\n", hRet
);
366 else if (psa
->fFeatures
& FADF_BSTR
)
368 BSTR
* lpBstr
= (BSTR
*)psa
->pvData
;
369 BSTR
* lpDest
= (BSTR
*)dest
->pvData
;
375 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
377 return E_OUTOFMEMORY
;
387 /* Copy the data over */
388 memcpy(dest
->pvData
, psa
->pvData
, ulCellCount
* psa
->cbElements
);
390 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
392 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)dest
->pvData
;
397 IUnknown_AddRef(*lpUnknown
);
403 if (psa
->fFeatures
& FADF_RECORD
)
405 IRecordInfo
* pRecInfo
= NULL
;
407 SafeArrayGetRecordInfo(psa
, &pRecInfo
);
408 SafeArraySetRecordInfo(dest
, pRecInfo
);
412 /* Release because Get() adds a reference */
413 IRecordInfo_Release(pRecInfo
);
416 else if (psa
->fFeatures
& FADF_HAVEIID
)
419 SafeArrayGetIID(psa
, &guid
);
420 SafeArraySetIID(dest
, &guid
);
422 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
424 SAFEARRAY_SetHiddenDWORD(dest
, SAFEARRAY_GetHiddenDWORD(psa
));
430 /*************************************************************************
431 * SafeArrayAllocDescriptor (OLEAUT32.36)
433 * Allocate and initialise a descriptor for a SafeArray.
436 * cDims [I] Number of dimensions of the array
437 * ppsaOut [O] Destination for new descriptor
440 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
441 * Failure: An HRESULT error code indicating the error.
446 HRESULT WINAPI
SafeArrayAllocDescriptor(UINT cDims
, SAFEARRAY
**ppsaOut
)
450 TRACE("(%d,%p)\n", cDims
, ppsaOut
);
452 if (!cDims
|| cDims
>= 0x10000) /* Maximum 65535 dimensions */
458 /* We need enough space for the header and its bounds */
459 allocSize
= sizeof(SAFEARRAY
) + sizeof(SAFEARRAYBOUND
) * (cDims
- 1);
461 if (FAILED(SAFEARRAY_AllocDescriptor(allocSize
, ppsaOut
)))
464 (*ppsaOut
)->cDims
= cDims
;
466 TRACE("(%d): %u bytes allocated for descriptor.\n", cDims
, allocSize
);
470 /*************************************************************************
471 * SafeArrayAllocDescriptorEx (OLEAUT32.41)
473 * Allocate and initialise a descriptor for a SafeArray of a given type.
476 * vt [I] The type of items to store in the array
477 * cDims [I] Number of dimensions of the array
478 * ppsaOut [O] Destination for new descriptor
481 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
482 * Failure: An HRESULT error code indicating the error.
485 * - This function does not check that vt is an allowed VARTYPE.
486 * - Unlike SafeArrayAllocDescriptor(), vt is associated with the array.
489 HRESULT WINAPI
SafeArrayAllocDescriptorEx(VARTYPE vt
, UINT cDims
, SAFEARRAY
**ppsaOut
)
492 HRESULT hRet
= E_UNEXPECTED
;
494 TRACE("(%d->%s,%d,%p)\n", vt
, debugstr_vt(vt
), cDims
, ppsaOut
);
496 cbElements
= SAFEARRAY_GetVTSize(vt
);
498 WARN("Creating a descriptor with an invalid VARTYPE!\n");
500 hRet
= SafeArrayAllocDescriptor(cDims
, ppsaOut
);
504 SAFEARRAY_SetFeatures(vt
, *ppsaOut
);
505 (*ppsaOut
)->cbElements
= cbElements
;
510 /*************************************************************************
511 * SafeArrayAllocData (OLEAUT32.37)
513 * Allocate the data area of a SafeArray.
516 * psa [I] SafeArray to allocate the data area of.
519 * Success: S_OK. The data area is allocated and initialised.
520 * Failure: An HRESULT error code indicating the error.
525 HRESULT WINAPI
SafeArrayAllocData(SAFEARRAY
*psa
)
527 HRESULT hRet
= E_INVALIDARG
;
529 TRACE("(%p)\n", psa
);
533 ULONG ulSize
= SAFEARRAY_GetCellCount(psa
);
535 psa
->pvData
= SAFEARRAY_Malloc(ulSize
* psa
->cbElements
);
540 TRACE("%u bytes allocated for data at %p (%u objects).\n",
541 ulSize
* psa
->cbElements
, psa
->pvData
, ulSize
);
544 hRet
= E_OUTOFMEMORY
;
549 /*************************************************************************
550 * SafeArrayCreate (OLEAUT32.15)
552 * Create a new SafeArray.
555 * vt [I] Type to store in the safe array
556 * cDims [I] Number of array dimensions
557 * rgsabound [I] Bounds of the array dimensions
560 * Success: A pointer to a new array object.
561 * Failure: NULL, if any parameter is invalid or memory allocation fails.
564 * Win32 allows arrays with 0 sized dimensions. This bug is not reproduced
565 * in the Wine implementation.
568 SAFEARRAY
* WINAPI
SafeArrayCreate(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
)
570 TRACE("(%d->%s,%d,%p)\n", vt
, debugstr_vt(vt
), cDims
, rgsabound
);
575 return SAFEARRAY_Create(vt
, cDims
, rgsabound
, 0);
578 /*************************************************************************
579 * SafeArrayCreateEx (OLEAUT32.15)
581 * Create a new SafeArray.
584 * vt [I] Type to store in the safe array
585 * cDims [I] Number of array dimensions
586 * rgsabound [I] Bounds of the array dimensions
587 * pvExtra [I] Extra data
590 * Success: A pointer to a new array object.
591 * Failure: NULL, if any parameter is invalid or memory allocation fails.
596 SAFEARRAY
* WINAPI
SafeArrayCreateEx(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
, LPVOID pvExtra
)
599 IRecordInfo
* iRecInfo
= (IRecordInfo
*)pvExtra
;
602 TRACE("(%d->%s,%d,%p,%p)\n", vt
, debugstr_vt(vt
), cDims
, rgsabound
, pvExtra
);
608 IRecordInfo_GetSize(iRecInfo
, &ulSize
);
610 psa
= SAFEARRAY_Create(vt
, cDims
, rgsabound
, ulSize
);
617 SafeArraySetRecordInfo(psa
, pvExtra
);
621 SafeArraySetIID(psa
, pvExtra
);
628 /************************************************************************
629 * SafeArrayCreateVector (OLEAUT32.411)
631 * Create a one dimensional, contiguous SafeArray.
634 * vt [I] Type to store in the safe array
635 * lLbound [I] Lower bound of the array
636 * cElements [I] Number of elements in the array
639 * Success: A pointer to a new array object.
640 * Failure: NULL, if any parameter is invalid or memory allocation fails.
645 SAFEARRAY
* WINAPI
SafeArrayCreateVector(VARTYPE vt
, LONG lLbound
, ULONG cElements
)
647 TRACE("(%d->%s,%d,%d\n", vt
, debugstr_vt(vt
), lLbound
, cElements
);
652 return SAFEARRAY_CreateVector(vt
, lLbound
, cElements
, SAFEARRAY_GetVTSize(vt
));
655 /************************************************************************
656 * SafeArrayCreateVectorEx (OLEAUT32.411)
658 * Create a one dimensional, contiguous SafeArray.
661 * vt [I] Type to store in the safe array
662 * lLbound [I] Lower bound of the array
663 * cElements [I] Number of elements in the array
664 * pvExtra [I] Extra data
667 * Success: A pointer to a new array object.
668 * Failure: NULL, if any parameter is invalid or memory allocation fails.
673 SAFEARRAY
* WINAPI
SafeArrayCreateVectorEx(VARTYPE vt
, LONG lLbound
, ULONG cElements
, LPVOID pvExtra
)
676 IRecordInfo
* iRecInfo
= (IRecordInfo
*)pvExtra
;
679 TRACE("(%d->%s,%d,%d,%p\n", vt
, debugstr_vt(vt
), lLbound
, cElements
, pvExtra
);
685 IRecordInfo_GetSize(iRecInfo
, &ulSize
);
688 ulSize
= SAFEARRAY_GetVTSize(vt
);
690 psa
= SAFEARRAY_CreateVector(vt
, lLbound
, cElements
, ulSize
);
697 SafeArraySetRecordInfo(psa
, iRecInfo
);
701 SafeArraySetIID(psa
, pvExtra
);
708 /*************************************************************************
709 * SafeArrayDestroyDescriptor (OLEAUT32.38)
711 * Destroy a SafeArray.
714 * psa [I] SafeArray to destroy.
717 * Success: S_OK. The resources used by the array are freed.
718 * Failure: An HRESULT error code indicating the error.
723 HRESULT WINAPI
SafeArrayDestroyDescriptor(SAFEARRAY
*psa
)
725 TRACE("(%p)\n", psa
);
729 LPVOID lpv
= (char*)psa
- SAFEARRAY_HIDDEN_SIZE
;
732 return DISP_E_ARRAYISLOCKED
; /* Can't destroy a locked array */
734 if (psa
->fFeatures
& FADF_RECORD
)
735 SafeArraySetRecordInfo(psa
, NULL
);
737 if (psa
->fFeatures
& FADF_CREATEVECTOR
&&
738 !(psa
->fFeatures
& FADF_DATADELETED
))
739 SAFEARRAY_DestroyData(psa
, 0); /* Data not previously deleted */
741 if (!SAFEARRAY_Free(lpv
))
747 /*************************************************************************
748 * SafeArrayLock (OLEAUT32.21)
750 * Increment the lock counter of a SafeArray.
753 * psa [O] SafeArray to lock
756 * Success: S_OK. The array lock is incremented.
757 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if too many locks
758 * are held on the array at once.
761 * In Win32 these locks are not thread safe.
764 HRESULT WINAPI
SafeArrayLock(SAFEARRAY
*psa
)
768 TRACE("(%p)\n", psa
);
773 ulLocks
= InterlockedIncrement( (LONG
*) &psa
->cLocks
);
775 if (ulLocks
> 0xffff) /* Maximum of 16384 locks at a time */
777 WARN("Out of locks!\n");
778 InterlockedDecrement( (LONG
*) &psa
->cLocks
);
784 /*************************************************************************
785 * SafeArrayUnlock (OLEAUT32.22)
787 * Decrement the lock counter of a SafeArray.
790 * psa [O] SafeArray to unlock
793 * Success: S_OK. The array lock is decremented.
794 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if no locks are
800 HRESULT WINAPI
SafeArrayUnlock(SAFEARRAY
*psa
)
802 TRACE("(%p)\n", psa
);
807 if (InterlockedDecrement( (LONG
*) &psa
->cLocks
) < 0)
809 WARN("Unlocked but no lock held!\n");
810 InterlockedIncrement( (LONG
*) &psa
->cLocks
);
816 /*************************************************************************
817 * SafeArrayPutElement (OLEAUT32.26)
819 * Put an item into a SafeArray.
822 * psa [I] SafeArray to insert into
823 * rgIndices [I] Indices to insert at
824 * pvData [I] Data to insert
827 * Success: S_OK. The item is inserted
828 * Failure: An HRESULT error code indicating the error.
833 HRESULT WINAPI
SafeArrayPutElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
837 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
839 if (!psa
|| !rgIndices
)
842 hRet
= SafeArrayLock(psa
);
848 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvDest
);
852 if (psa
->fFeatures
& FADF_VARIANT
)
854 VARIANT
* lpVariant
= (VARIANT
*)pvData
;
855 VARIANT
* lpDest
= (VARIANT
*)lpvDest
;
857 hRet
= VariantClear(lpDest
);
858 if (FAILED(hRet
)) FIXME("VariantClear failed with 0x%x\n", hRet
);
859 hRet
= VariantCopy(lpDest
, lpVariant
);
860 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%x\n", hRet
);
862 else if (psa
->fFeatures
& FADF_BSTR
)
864 BSTR lpBstr
= (BSTR
)pvData
;
865 BSTR
* lpDest
= (BSTR
*)lpvDest
;
867 SysFreeString(*lpDest
);
869 *lpDest
= SysAllocStringByteLen((char*)lpBstr
, SysStringByteLen(lpBstr
));
871 hRet
= E_OUTOFMEMORY
;
875 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
877 LPUNKNOWN lpUnknown
= (LPUNKNOWN
)pvData
;
878 LPUNKNOWN
*lpDest
= (LPUNKNOWN
*)lpvDest
;
881 IUnknown_AddRef(lpUnknown
);
883 IUnknown_Release(*lpDest
);
886 /* Copy the data over */
887 memcpy(lpvDest
, pvData
, psa
->cbElements
);
891 SafeArrayUnlock(psa
);
897 /*************************************************************************
898 * SafeArrayGetElement (OLEAUT32.25)
900 * Get an item from a SafeArray.
903 * psa [I] SafeArray to get from
904 * rgIndices [I] Indices to get from
905 * pvData [O] Destination for data
908 * Success: S_OK. The item data is returned in pvData.
909 * Failure: An HRESULT error code indicating the error.
914 HRESULT WINAPI
SafeArrayGetElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
918 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
920 if (!psa
|| !rgIndices
|| !pvData
)
923 hRet
= SafeArrayLock(psa
);
929 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvSrc
);
933 if (psa
->fFeatures
& FADF_VARIANT
)
935 VARIANT
* lpVariant
= (VARIANT
*)lpvSrc
;
936 VARIANT
* lpDest
= (VARIANT
*)pvData
;
938 /* The original content of pvData is ignored. */
939 V_VT(lpDest
) = VT_EMPTY
;
940 hRet
= VariantCopy(lpDest
, lpVariant
);
941 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%x\n", hRet
);
943 else if (psa
->fFeatures
& FADF_BSTR
)
945 BSTR
* lpBstr
= (BSTR
*)lpvSrc
;
946 BSTR
* lpDest
= (BSTR
*)pvData
;
950 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
952 hRet
= E_OUTOFMEMORY
;
959 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
961 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)lpvSrc
;
964 IUnknown_AddRef(*lpUnknown
);
966 /* Copy the data over */
967 memcpy(pvData
, lpvSrc
, psa
->cbElements
);
970 SafeArrayUnlock(psa
);
975 /*************************************************************************
976 * SafeArrayGetUBound (OLEAUT32.19)
978 * Get the upper bound for a given SafeArray dimension
981 * psa [I] Array to get dimension upper bound from
982 * nDim [I] The dimension number to get the upper bound of
983 * plUbound [O] Destination for the upper bound
986 * Success: S_OK. plUbound contains the dimensions upper bound.
987 * Failure: An HRESULT error code indicating the error.
992 HRESULT WINAPI
SafeArrayGetUBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plUbound
)
994 TRACE("(%p,%d,%p)\n", psa
, nDim
, plUbound
);
996 if (!psa
|| !plUbound
)
999 if(!nDim
|| nDim
> psa
->cDims
)
1000 return DISP_E_BADINDEX
;
1002 *plUbound
= psa
->rgsabound
[psa
->cDims
- nDim
].lLbound
+
1003 psa
->rgsabound
[psa
->cDims
- nDim
].cElements
- 1;
1008 /*************************************************************************
1009 * SafeArrayGetLBound (OLEAUT32.20)
1011 * Get the lower bound for a given SafeArray dimension
1014 * psa [I] Array to get dimension lower bound from
1015 * nDim [I] The dimension number to get the lowe bound of
1016 * plLbound [O] Destination for the lower bound
1019 * Success: S_OK. plUbound contains the dimensions lower bound.
1020 * Failure: An HRESULT error code indicating the error.
1025 HRESULT WINAPI
SafeArrayGetLBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plLbound
)
1027 TRACE("(%p,%d,%p)\n", psa
, nDim
, plLbound
);
1029 if (!psa
|| !plLbound
)
1030 return E_INVALIDARG
;
1032 if(!nDim
|| nDim
> psa
->cDims
)
1033 return DISP_E_BADINDEX
;
1035 *plLbound
= psa
->rgsabound
[psa
->cDims
- nDim
].lLbound
;
1039 /*************************************************************************
1040 * SafeArrayGetDim (OLEAUT32.17)
1042 * Get the number of dimensions in a SafeArray.
1045 * psa [I] Array to get the dimensions of
1048 * The number of array dimensions in psa, or 0 if psa is NULL.
1053 UINT WINAPI
SafeArrayGetDim(SAFEARRAY
*psa
)
1055 TRACE("(%p) returning %d\n", psa
, psa
? psa
->cDims
: 0u);
1056 return psa
? psa
->cDims
: 0;
1059 /*************************************************************************
1060 * SafeArrayGetElemsize (OLEAUT32.18)
1062 * Get the size of an element in a SafeArray.
1065 * psa [I] Array to get the element size from
1068 * The size of a single element in psa, or 0 if psa is NULL.
1073 UINT WINAPI
SafeArrayGetElemsize(SAFEARRAY
*psa
)
1075 TRACE("(%p) returning %d\n", psa
, psa
? psa
->cbElements
: 0u);
1076 return psa
? psa
->cbElements
: 0;
1079 /*************************************************************************
1080 * SafeArrayAccessData (OLEAUT32.23)
1082 * Lock a SafeArray and return a pointer to its data.
1085 * psa [I] Array to get the data pointer from
1086 * ppvData [O] Destination for the arrays data pointer
1089 * Success: S_OK. ppvData contains the arrays data pointer, and the array
1091 * Failure: An HRESULT error code indicating the error.
1096 HRESULT WINAPI
SafeArrayAccessData(SAFEARRAY
*psa
, void **ppvData
)
1098 TRACE("(%p,%p)\n", psa
, ppvData
);
1100 if(!psa
|| !ppvData
)
1101 return E_INVALIDARG
;
1103 if (SUCCEEDED(SafeArrayLock(psa
)))
1105 *ppvData
= psa
->pvData
;
1109 return E_UNEXPECTED
;
1113 /*************************************************************************
1114 * SafeArrayUnaccessData (OLEAUT32.24)
1116 * Unlock a SafeArray after accessing its data.
1119 * psa [I] Array to unlock
1122 * Success: S_OK. The array is unlocked.
1123 * Failure: An HRESULT error code indicating the error.
1128 HRESULT WINAPI
SafeArrayUnaccessData(SAFEARRAY
*psa
)
1130 TRACE("(%p)\n", psa
);
1131 return SafeArrayUnlock(psa
);
1134 /************************************************************************
1135 * SafeArrayPtrOfIndex (OLEAUT32.148)
1137 * Get the address of an item in a SafeArray.
1140 * psa [I] Array to get the items address from
1141 * rgIndices [I] Index of the item in the array
1142 * ppvData [O] Destination for item address
1145 * Success: S_OK. ppvData contains a pointer to the item.
1146 * Failure: An HRESULT error code indicating the error.
1149 * This function does not lock the array.
1154 HRESULT WINAPI
SafeArrayPtrOfIndex(SAFEARRAY
*psa
, LONG
*rgIndices
, void **ppvData
)
1157 ULONG cell
= 0, dimensionSize
= 1;
1158 SAFEARRAYBOUND
* psab
;
1161 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, ppvData
);
1163 /* The general formula for locating the cell number of an entry in an n
1164 * dimensional array (where cn = coordinate in dimension dn) is:
1166 * c1 + c2 * sizeof(d1) + c3 * sizeof(d2) ... + cn * sizeof(c(n-1))
1168 * We calculate the size of the last dimension at each step through the
1169 * dimensions to avoid recursing to calculate the last dimensions size.
1171 if (!psa
|| !rgIndices
|| !ppvData
)
1172 return E_INVALIDARG
;
1174 psab
= psa
->rgsabound
+ psa
->cDims
- 1;
1177 if (c1
< psab
->lLbound
|| c1
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1178 return DISP_E_BADINDEX
; /* Initial index out of bounds */
1180 for (dim
= 1; dim
< psa
->cDims
; dim
++)
1182 dimensionSize
*= psab
->cElements
;
1186 if (!psab
->cElements
||
1187 *rgIndices
< psab
->lLbound
||
1188 *rgIndices
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1189 return DISP_E_BADINDEX
; /* Index out of bounds */
1191 cell
+= (*rgIndices
- psab
->lLbound
) * dimensionSize
;
1195 cell
+= (c1
- psa
->rgsabound
[psa
->cDims
- 1].lLbound
);
1197 *ppvData
= (char*)psa
->pvData
+ cell
* psa
->cbElements
;
1201 /************************************************************************
1202 * SafeArrayDestroyData (OLEAUT32.39)
1204 * Destroy the data associated with a SafeArray.
1207 * psa [I] Array to delete the data from
1210 * Success: S_OK. All items and the item data are freed.
1211 * Failure: An HRESULT error code indicating the error.
1216 HRESULT WINAPI
SafeArrayDestroyData(SAFEARRAY
*psa
)
1218 TRACE("(%p)\n", psa
);
1221 return E_INVALIDARG
;
1224 return DISP_E_ARRAYISLOCKED
; /* Can't delete a locked array */
1226 /* Delete the actual item data */
1227 if (FAILED(SAFEARRAY_DestroyData(psa
, 0)))
1228 return E_UNEXPECTED
;
1232 if (psa
->fFeatures
& FADF_STATIC
)
1234 ZeroMemory(psa
->pvData
, SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
);
1237 /* If this is not a vector, free the data memory block */
1238 if (!(psa
->fFeatures
& FADF_CREATEVECTOR
))
1240 if (!SAFEARRAY_Free(psa
->pvData
))
1241 return E_UNEXPECTED
;
1245 psa
->fFeatures
|= FADF_DATADELETED
; /* Mark the data deleted */
1251 /************************************************************************
1252 * SafeArrayCopyData (OLEAUT32.412)
1254 * Copy all data from one SafeArray to another.
1257 * psaSource [I] Source for copy
1258 * psaTarget [O] Destination for copy
1261 * Success: S_OK. psaTarget contains a copy of psaSource.
1262 * Failure: An HRESULT error code indicating the error.
1265 * The two arrays must have the same number of dimensions and elements.
1270 HRESULT WINAPI
SafeArrayCopyData(SAFEARRAY
*psaSource
, SAFEARRAY
*psaTarget
)
1274 TRACE("(%p,%p)\n", psaSource
, psaTarget
);
1276 if (!psaSource
|| !psaTarget
||
1277 psaSource
->cDims
!= psaTarget
->cDims
||
1278 psaSource
->cbElements
!= psaTarget
->cbElements
)
1279 return E_INVALIDARG
;
1281 /* Each dimension must be the same size */
1282 for (dim
= psaSource
->cDims
- 1; dim
>= 0 ; dim
--)
1283 if (psaSource
->rgsabound
[dim
].cElements
!=
1284 psaTarget
->rgsabound
[dim
].cElements
)
1285 return E_INVALIDARG
;
1287 if (SUCCEEDED(SAFEARRAY_DestroyData(psaTarget
, 0)) &&
1288 SUCCEEDED(SAFEARRAY_CopyData(psaSource
, psaTarget
)))
1290 return E_UNEXPECTED
;
1293 /************************************************************************
1294 * SafeArrayDestroy (OLEAUT32.16)
1296 * Destroy a SafeArray.
1299 * psa [I] Array to destroy
1302 * Success: S_OK. All resources used by the array are freed.
1303 * Failure: An HRESULT error code indicating the error.
1308 HRESULT WINAPI
SafeArrayDestroy(SAFEARRAY
*psa
)
1310 TRACE("(%p)\n", psa
);
1316 return DISP_E_ARRAYISLOCKED
;
1318 /* Native doesn't check to see if the free succeeds */
1319 SafeArrayDestroyData(psa
);
1320 SafeArrayDestroyDescriptor(psa
);
1324 /************************************************************************
1325 * SafeArrayCopy (OLEAUT32.27)
1327 * Make a duplicate of a SafeArray.
1330 * psa [I] Source for copy
1331 * ppsaOut [O] Destination for new copy
1334 * Success: S_OK. ppsaOut contains a copy of the array.
1335 * Failure: An HRESULT error code indicating the error.
1340 HRESULT WINAPI
SafeArrayCopy(SAFEARRAY
*psa
, SAFEARRAY
**ppsaOut
)
1344 TRACE("(%p,%p)\n", psa
, ppsaOut
);
1347 return E_INVALIDARG
;
1352 return S_OK
; /* Handles copying of NULL arrays */
1354 if (!psa
->cbElements
)
1356 ERR("not copying an array of 0 elements\n");
1357 return E_INVALIDARG
;
1360 if (psa
->fFeatures
& (FADF_RECORD
|FADF_HAVEIID
|FADF_HAVEVARTYPE
))
1363 if (FAILED(SafeArrayGetVartype(psa
, &vt
)))
1364 hRet
= E_UNEXPECTED
;
1366 hRet
= SafeArrayAllocDescriptorEx(vt
, psa
->cDims
, ppsaOut
);
1370 hRet
= SafeArrayAllocDescriptor(psa
->cDims
, ppsaOut
);
1371 if (SUCCEEDED(hRet
))
1373 (*ppsaOut
)->fFeatures
= psa
->fFeatures
& ~FADF_CREATEVECTOR
;
1374 (*ppsaOut
)->cbElements
= psa
->cbElements
;
1378 if (SUCCEEDED(hRet
))
1380 /* Copy dimension bounds */
1381 memcpy((*ppsaOut
)->rgsabound
, psa
->rgsabound
, psa
->cDims
* sizeof(SAFEARRAYBOUND
));
1383 (*ppsaOut
)->pvData
= SAFEARRAY_Malloc(SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
);
1385 if ((*ppsaOut
)->pvData
)
1387 hRet
= SAFEARRAY_CopyData(psa
, *ppsaOut
);
1389 if (SUCCEEDED(hRet
))
1392 SAFEARRAY_Free((*ppsaOut
)->pvData
);
1394 SafeArrayDestroyDescriptor(*ppsaOut
);
1400 /************************************************************************
1401 * SafeArrayRedim (OLEAUT32.40)
1403 * Changes the characteristics of the last dimension of a SafeArray
1406 * psa [I] Array to change
1407 * psabound [I] New bound details for the last dimension
1410 * Success: S_OK. psa is updated to reflect the new bounds.
1411 * Failure: An HRESULT error code indicating the error.
1416 HRESULT WINAPI
SafeArrayRedim(SAFEARRAY
*psa
, SAFEARRAYBOUND
*psabound
)
1418 SAFEARRAYBOUND
*oldBounds
;
1420 TRACE("(%p,%p)\n", psa
, psabound
);
1422 if (!psa
|| psa
->fFeatures
& FADF_FIXEDSIZE
|| !psabound
)
1423 return E_INVALIDARG
;
1425 if (psa
->cLocks
> 0)
1426 return DISP_E_ARRAYISLOCKED
;
1428 if (FAILED(SafeArrayLock(psa
)))
1429 return E_UNEXPECTED
;
1431 oldBounds
= psa
->rgsabound
;
1432 oldBounds
->lLbound
= psabound
->lLbound
;
1434 if (psabound
->cElements
!= oldBounds
->cElements
)
1436 if (psabound
->cElements
< oldBounds
->cElements
)
1438 /* Shorten the final dimension. */
1439 ULONG ulStartCell
= psabound
->cElements
*
1440 (SAFEARRAY_GetCellCount(psa
) / oldBounds
->cElements
);
1441 SAFEARRAY_DestroyData(psa
, ulStartCell
);
1445 /* Lengthen the final dimension */
1446 ULONG ulOldSize
, ulNewSize
;
1449 ulOldSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1451 ulNewSize
= (ulOldSize
/ oldBounds
->cElements
) * psabound
->cElements
;
1453 int oldelems
= oldBounds
->cElements
;
1454 oldBounds
->cElements
= psabound
->cElements
;
1455 ulNewSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1456 oldBounds
->cElements
= oldelems
;
1459 if (!(pvNewData
= SAFEARRAY_Malloc(ulNewSize
)))
1461 SafeArrayUnlock(psa
);
1462 return E_UNEXPECTED
;
1465 memcpy(pvNewData
, psa
->pvData
, ulOldSize
);
1466 SAFEARRAY_Free(psa
->pvData
);
1467 psa
->pvData
= pvNewData
;
1469 oldBounds
->cElements
= psabound
->cElements
;
1472 SafeArrayUnlock(psa
);
1476 /************************************************************************
1477 * SafeArrayGetVartype (OLEAUT32.77)
1479 * Get the type of the items in a SafeArray.
1482 * psa [I] Array to get the type from
1483 * pvt [O] Destination for the type
1486 * Success: S_OK. pvt contains the type of the items.
1487 * Failure: An HRESULT error code indicating the error.
1492 HRESULT WINAPI
SafeArrayGetVartype(SAFEARRAY
* psa
, VARTYPE
* pvt
)
1494 TRACE("(%p,%p)\n", psa
, pvt
);
1497 return E_INVALIDARG
;
1499 if (psa
->fFeatures
& FADF_RECORD
)
1501 else if ((psa
->fFeatures
& (FADF_HAVEIID
|FADF_DISPATCH
)) == (FADF_HAVEIID
|FADF_DISPATCH
))
1503 else if (psa
->fFeatures
& FADF_HAVEIID
)
1505 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
1507 VARTYPE vt
= SAFEARRAY_GetHiddenDWORD(psa
);
1511 return E_INVALIDARG
;
1516 /************************************************************************
1517 * SafeArraySetRecordInfo (OLEAUT32.@)
1519 * Set the record info for a SafeArray.
1522 * psa [I] Array to set the record info for
1523 * pRinfo [I] Record info
1526 * Success: S_OK. The record info is stored with the array.
1527 * Failure: An HRESULT error code indicating the error.
1532 HRESULT WINAPI
SafeArraySetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
*pRinfo
)
1534 IRecordInfo
** dest
= (IRecordInfo
**)psa
;
1536 TRACE("(%p,%p)\n", psa
, pRinfo
);
1538 if (!psa
|| !(psa
->fFeatures
& FADF_RECORD
))
1539 return E_INVALIDARG
;
1542 IRecordInfo_AddRef(pRinfo
);
1545 IRecordInfo_Release(dest
[-1]);
1551 /************************************************************************
1552 * SafeArrayGetRecordInfo (OLEAUT32.@)
1554 * Get the record info from a SafeArray.
1557 * psa [I] Array to get the record info from
1558 * pRinfo [O] Destination for the record info
1561 * Success: S_OK. pRinfo contains the record info, or NULL if there was none.
1562 * Failure: An HRESULT error code indicating the error.
1567 HRESULT WINAPI
SafeArrayGetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
**pRinfo
)
1569 IRecordInfo
** src
= (IRecordInfo
**)psa
;
1571 TRACE("(%p,%p)\n", psa
, pRinfo
);
1573 if (!psa
|| !pRinfo
|| !(psa
->fFeatures
& FADF_RECORD
))
1574 return E_INVALIDARG
;
1579 IRecordInfo_AddRef(*pRinfo
);
1583 /************************************************************************
1584 * SafeArraySetIID (OLEAUT32.@)
1586 * Set the IID for a SafeArray.
1589 * psa [I] Array to set the IID from
1593 * Success: S_OK. The IID is stored with the array
1594 * Failure: An HRESULT error code indicating the error.
1599 HRESULT WINAPI
SafeArraySetIID(SAFEARRAY
*psa
, REFGUID guid
)
1601 GUID
* dest
= (GUID
*)psa
;
1603 TRACE("(%p,%s)\n", psa
, debugstr_guid(guid
));
1605 if (!psa
|| !guid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1606 return E_INVALIDARG
;
1612 /************************************************************************
1613 * SafeArrayGetIID (OLEAUT32.@)
1615 * Get the IID from a SafeArray.
1618 * psa [I] Array to get the ID from
1619 * pGuid [O] Destination for the IID
1622 * Success: S_OK. pRinfo contains the IID, or NULL if there was none.
1623 * Failure: An HRESULT error code indicating the error.
1628 HRESULT WINAPI
SafeArrayGetIID(SAFEARRAY
*psa
, GUID
*pGuid
)
1630 GUID
* src
= (GUID
*)psa
;
1632 TRACE("(%p,%p)\n", psa
, pGuid
);
1634 if (!psa
|| !pGuid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1635 return E_INVALIDARG
;
1641 /************************************************************************
1642 * VectorFromBstr (OLEAUT32.@)
1644 * Create a SafeArray Vector from the bytes of a BSTR.
1647 * bstr [I] String to get bytes from
1648 * ppsa [O] Destination for the array
1651 * Success: S_OK. ppsa contains the strings bytes as a VT_UI1 array.
1652 * Failure: An HRESULT error code indicating the error.
1657 HRESULT WINAPI
VectorFromBstr(BSTR bstr
, SAFEARRAY
**ppsa
)
1661 TRACE("(%p,%p)\n", bstr
, ppsa
);
1664 return E_INVALIDARG
;
1667 sab
.cElements
= SysStringByteLen(bstr
);
1669 *ppsa
= SAFEARRAY_Create(VT_UI1
, 1, &sab
, 0);
1673 memcpy((*ppsa
)->pvData
, bstr
, sab
.cElements
);
1676 return E_OUTOFMEMORY
;
1679 /************************************************************************
1680 * BstrFromVector (OLEAUT32.@)
1682 * Create a BSTR from a SafeArray.
1685 * psa [I] Source array
1686 * pbstr [O] Destination for output BSTR
1689 * Success: S_OK. pbstr contains the arrays data.
1690 * Failure: An HRESULT error code indicating the error.
1693 * psa must be a 1 dimensional array of a 1 byte type.
1698 HRESULT WINAPI
BstrFromVector(SAFEARRAY
*psa
, BSTR
*pbstr
)
1700 TRACE("(%p,%p)\n", psa
, pbstr
);
1703 return E_INVALIDARG
;
1707 if (!psa
|| psa
->cbElements
!= 1 || psa
->cDims
!= 1)
1708 return E_INVALIDARG
;
1710 *pbstr
= SysAllocStringByteLen(psa
->pvData
, psa
->rgsabound
[0].cElements
);
1712 return E_OUTOFMEMORY
;