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 /* 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 HRESULT hRet
= VariantClear(lpVariant
);
347 if (FAILED(hRet
)) FIXME("VariantClear of element failed!\n");
355 /* Copy data items from one array to another */
356 static HRESULT
SAFEARRAY_CopyData(SAFEARRAY
*psa
, SAFEARRAY
*dest
)
360 else if (!dest
->pvData
|| psa
->fFeatures
& FADF_DATADELETED
)
364 ULONG ulCellCount
= SAFEARRAY_GetCellCount(psa
);
366 dest
->fFeatures
= (dest
->fFeatures
& FADF_CREATEVECTOR
) |
367 (psa
->fFeatures
& ~(FADF_CREATEVECTOR
|FADF_DATADELETED
));
369 if (psa
->fFeatures
& FADF_VARIANT
)
371 VARIANT
* lpVariant
= (VARIANT
*)psa
->pvData
;
372 VARIANT
* lpDest
= (VARIANT
*)dest
->pvData
;
378 hRet
= VariantCopy(lpDest
, lpVariant
);
379 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%lx\n", hRet
);
384 else if (psa
->fFeatures
& FADF_BSTR
)
386 BSTR
* lpBstr
= (BSTR
*)psa
->pvData
;
387 BSTR
* lpDest
= (BSTR
*)dest
->pvData
;
393 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
395 return E_OUTOFMEMORY
;
405 /* Copy the data over */
406 memcpy(dest
->pvData
, psa
->pvData
, ulCellCount
* psa
->cbElements
);
408 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
410 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)dest
->pvData
;
415 IUnknown_AddRef(*lpUnknown
);
421 if (psa
->fFeatures
& FADF_RECORD
)
423 IRecordInfo
* pRecInfo
= NULL
;
425 SafeArrayGetRecordInfo(psa
, &pRecInfo
);
426 SafeArraySetRecordInfo(dest
, pRecInfo
);
430 /* Release because Get() adds a reference */
431 IRecordInfo_Release(pRecInfo
);
434 else if (psa
->fFeatures
& FADF_HAVEIID
)
437 SafeArrayGetIID(psa
, &guid
);
438 SafeArraySetIID(dest
, &guid
);
440 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
442 SAFEARRAY_SetHiddenDWORD(dest
, SAFEARRAY_GetHiddenDWORD(psa
));
448 /*************************************************************************
449 * SafeArrayAllocDescriptor (OLEAUT32.36)
451 * Allocate and initialise a descriptor for a SafeArray.
454 * cDims [I] Number of dimensions of the array
455 * ppsaOut [O] Destination for new descriptor
458 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
459 * Failure: An HRESULT error code indicating the error.
464 HRESULT WINAPI
SafeArrayAllocDescriptor(UINT cDims
, SAFEARRAY
**ppsaOut
)
468 TRACE("(%d,%p)\n", cDims
, ppsaOut
);
470 if (!cDims
|| cDims
>= 0x10000) /* Maximum 65535 dimensions */
476 /* We need enough space for the header and its bounds */
477 allocSize
= sizeof(SAFEARRAY
) + sizeof(SAFEARRAYBOUND
) * (cDims
- 1);
479 if (FAILED(SAFEARRAY_AllocDescriptor(allocSize
, ppsaOut
)))
482 (*ppsaOut
)->cDims
= cDims
;
484 TRACE("(%d): %lu bytes allocated for descriptor.\n", cDims
, allocSize
);
488 /*************************************************************************
489 * SafeArrayAllocDescriptorEx (OLEAUT32.41)
491 * Allocate and initialise a descriptor for a SafeArray of a given type.
494 * vt [I] The type of items to store in the array
495 * cDims [I] Number of dimensions of the array
496 * ppsaOut [O] Destination for new descriptor
499 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
500 * Failure: An HRESULT error code indicating the error.
503 * - This function does not chack that vt is an allowed VARTYPE.
504 * - Unlike SafeArrayAllocDescriptor(), vt is associated with the array.
507 HRESULT WINAPI
SafeArrayAllocDescriptorEx(VARTYPE vt
, UINT cDims
, SAFEARRAY
**ppsaOut
)
510 HRESULT hRet
= E_UNEXPECTED
;
512 TRACE("(%d->%s,%d,%p)\n", vt
, debugstr_vt(vt
), cDims
, ppsaOut
);
514 cbElements
= SAFEARRAY_GetVTSize(vt
);
516 WARN("Creating a descriptor with an invalid VARTYPE!\n");
518 hRet
= SafeArrayAllocDescriptor(cDims
, ppsaOut
);
522 SAFEARRAY_SetFeatures(vt
, *ppsaOut
);
523 (*ppsaOut
)->cbElements
= cbElements
;
528 /*************************************************************************
529 * SafeArrayAllocData (OLEAUT32.37)
531 * Allocate the data area of a SafeArray.
534 * psa [I] SafeArray to allocate the data area of.
537 * Success: S_OK. The data area is allocated and initialised.
538 * Failure: An HRESULT error code indicating the error.
543 HRESULT WINAPI
SafeArrayAllocData(SAFEARRAY
*psa
)
545 HRESULT hRet
= E_INVALIDARG
;
547 TRACE("(%p)\n", psa
);
551 ULONG ulSize
= SAFEARRAY_GetCellCount(psa
);
553 hRet
= E_OUTOFMEMORY
;
557 psa
->pvData
= SAFEARRAY_Malloc(ulSize
* psa
->cbElements
);
562 TRACE("%lu bytes allocated for data at %p (%lu objects).\n",
563 ulSize
* psa
->cbElements
, psa
->pvData
, ulSize
);
570 /*************************************************************************
571 * SafeArrayCreate (OLEAUT32.15)
573 * Create a new SafeArray.
576 * vt [I] Type to store in the safe array
577 * cDims [I] Number of array dimensions
578 * rgsabound [I] Bounds of the array dimensions
581 * Success: A pointer to a new array object.
582 * Failure: NULL, if any parameter is invalid or memory allocation fails.
585 * Win32 allows arrays with 0 sized dimensions. This bug is not reproduced
586 * in the Wine implementation.
589 SAFEARRAY
* WINAPI
SafeArrayCreate(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
)
591 TRACE("(%d->%s,%d,%p)\n", vt
, debugstr_vt(vt
), cDims
, rgsabound
);
596 return SAFEARRAY_Create(vt
, cDims
, rgsabound
, 0);
599 /*************************************************************************
600 * SafeArrayCreateEx (OLEAUT32.15)
602 * Create a new SafeArray.
605 * vt [I] Type to store in the safe array
606 * cDims [I] Number of array dimensions
607 * rgsabound [I] Bounds of the array dimensions
608 * pvExtra [I] Extra data
611 * Success: A pointer to a new array object.
612 * Failure: NULL, if any parameter is invalid or memory allocation fails.
617 SAFEARRAY
* WINAPI
SafeArrayCreateEx(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
, LPVOID pvExtra
)
620 IRecordInfo
* iRecInfo
= (IRecordInfo
*)pvExtra
;
623 TRACE("(%d->%s,%d,%p,%p)\n", vt
, debugstr_vt(vt
), cDims
, rgsabound
, pvExtra
);
629 IRecordInfo_GetSize(iRecInfo
, &ulSize
);
631 psa
= SAFEARRAY_Create(vt
, cDims
, rgsabound
, ulSize
);
638 SafeArraySetRecordInfo(psa
, pvExtra
);
642 SafeArraySetIID(psa
, pvExtra
);
649 /************************************************************************
650 * SafeArrayCreateVector (OLEAUT32.411)
652 * Create a one dimensional, contiguous SafeArray.
655 * vt [I] Type to store in the safe array
656 * lLbound [I] Lower bound of the array
657 * cElements [I] Number of elements in the array
660 * Success: A pointer to a new array object.
661 * Failure: NULL, if any parameter is invalid or memory allocation fails.
666 SAFEARRAY
* WINAPI
SafeArrayCreateVector(VARTYPE vt
, LONG lLbound
, ULONG cElements
)
668 TRACE("(%d->%s,%ld,%ld\n", vt
, debugstr_vt(vt
), lLbound
, cElements
);
673 return SAFEARRAY_CreateVector(vt
, lLbound
, cElements
, SAFEARRAY_GetVTSize(vt
));
676 /************************************************************************
677 * SafeArrayCreateVectorEx (OLEAUT32.411)
679 * Create a one dimensional, contiguous SafeArray.
682 * vt [I] Type to store in the safe array
683 * lLbound [I] Lower bound of the array
684 * cElements [I] Number of elements in the array
685 * pvExtra [I] Extra data
688 * Success: A pointer to a new array object.
689 * Failure: NULL, if any parameter is invalid or memory allocation fails.
694 SAFEARRAY
* WINAPI
SafeArrayCreateVectorEx(VARTYPE vt
, LONG lLbound
, ULONG cElements
, LPVOID pvExtra
)
697 IRecordInfo
* iRecInfo
= (IRecordInfo
*)pvExtra
;
700 TRACE("(%d->%s,%ld,%ld,%p\n", vt
, debugstr_vt(vt
), lLbound
, cElements
, pvExtra
);
706 IRecordInfo_GetSize(iRecInfo
, &ulSize
);
709 ulSize
= SAFEARRAY_GetVTSize(vt
);
711 psa
= SAFEARRAY_CreateVector(vt
, lLbound
, cElements
, ulSize
);
718 SafeArraySetRecordInfo(psa
, iRecInfo
);
722 SafeArraySetIID(psa
, pvExtra
);
729 /*************************************************************************
730 * SafeArrayDestroyDescriptor (OLEAUT32.38)
732 * Destroy a SafeArray.
735 * psa [I] SafeArray to destroy.
738 * Success: S_OK. The resources used by the array are freed.
739 * Failure: An HRESULT error code indicating the error.
744 HRESULT WINAPI
SafeArrayDestroyDescriptor(SAFEARRAY
*psa
)
746 TRACE("(%p)\n", psa
);
750 LPVOID lpv
= (char*)psa
- SAFEARRAY_HIDDEN_SIZE
;
753 return DISP_E_ARRAYISLOCKED
; /* Can't destroy a locked array */
755 if (psa
->fFeatures
& FADF_RECORD
)
756 SafeArraySetRecordInfo(psa
, NULL
);
758 if (psa
->fFeatures
& FADF_CREATEVECTOR
&&
759 !(psa
->fFeatures
& FADF_DATADELETED
))
760 SAFEARRAY_DestroyData(psa
, 0); /* Data not previously deleted */
762 if (!SAFEARRAY_Free(lpv
))
768 /*************************************************************************
769 * SafeArrayLock (OLEAUT32.21)
771 * Increment the lock counter of a SafeArray.
774 * psa [O] SafeArray to lock
777 * Success: S_OK. The array lock is incremented.
778 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if too many locks
779 * are held on the array at once.
782 * In Win32 these locks are not thread safe.
785 HRESULT WINAPI
SafeArrayLock(SAFEARRAY
*psa
)
789 TRACE("(%p)\n", psa
);
794 ulLocks
= InterlockedIncrement( (LONG
*) &psa
->cLocks
);
796 if (ulLocks
> 0xffff) /* Maximum of 16384 locks at a time */
798 WARN("Out of locks!\n");
799 InterlockedDecrement( (LONG
*) &psa
->cLocks
);
805 /*************************************************************************
806 * SafeArrayUnlock (OLEAUT32.22)
808 * Decrement the lock counter of a SafeArray.
811 * psa [O] SafeArray to unlock
814 * Success: S_OK. The array lock is decremented.
815 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if no locks are
821 HRESULT WINAPI
SafeArrayUnlock(SAFEARRAY
*psa
)
823 TRACE("(%p)\n", psa
);
828 if ((LONG
)InterlockedDecrement( (LONG
*) &psa
->cLocks
) < 0)
830 WARN("Unlocked but no lock held!\n");
831 InterlockedIncrement( (LONG
*) &psa
->cLocks
);
837 /*************************************************************************
838 * SafeArrayPutElement (OLEAUT32.26)
840 * Put an item into a SafeArray.
843 * psa [I] SafeArray to insert into
844 * rgIndices [I] Indices to insert at
845 * pvData [I] Data to insert
848 * Success: S_OK. The item is inserted
849 * Failure: An HRESULT error code indicating the error.
854 HRESULT WINAPI
SafeArrayPutElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
858 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
860 if (!psa
|| !rgIndices
)
865 ERR("Invalid pvData would crash under Win32!\n");
869 hRet
= SafeArrayLock(psa
);
875 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvDest
);
879 if (psa
->fFeatures
& FADF_VARIANT
)
881 VARIANT
* lpVariant
= (VARIANT
*)pvData
;
882 VARIANT
* lpDest
= (VARIANT
*)lpvDest
;
884 hRet
= VariantClear(lpDest
);
885 if (FAILED(hRet
)) FIXME("VariantClear failed with 0x%lx\n", hRet
);
886 hRet
= VariantCopy(lpDest
, lpVariant
);
887 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%lx\n", hRet
);
889 else if (psa
->fFeatures
& FADF_BSTR
)
891 BSTR lpBstr
= (BSTR
)pvData
;
892 BSTR
* lpDest
= (BSTR
*)lpvDest
;
895 SysFreeString(*lpDest
);
897 *lpDest
= SysAllocStringByteLen((char*)lpBstr
, SysStringByteLen(lpBstr
));
899 hRet
= E_OUTOFMEMORY
;
903 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
905 LPUNKNOWN lpUnknown
= (LPUNKNOWN
)pvData
;
906 LPUNKNOWN
*lpDest
= (LPUNKNOWN
*)lpvDest
;
909 IUnknown_AddRef(lpUnknown
);
911 IUnknown_Release(*lpDest
);
914 /* Copy the data over */
915 memcpy(lpvDest
, pvData
, psa
->cbElements
);
919 SafeArrayUnlock(psa
);
925 /*************************************************************************
926 * SafeArrayGetElement (OLEAUT32.25)
928 * Get an item from a SafeArray.
931 * psa [I] SafeArray to get from
932 * rgIndices [I] Indices to get from
933 * pvData [O] Destination for data
936 * Success: S_OK. The item data is returned in pvData.
937 * Failure: An HRESULT error code indicating the error.
942 HRESULT WINAPI
SafeArrayGetElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
946 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
948 if (!psa
|| !rgIndices
|| !pvData
)
951 hRet
= SafeArrayLock(psa
);
957 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvSrc
);
961 if (psa
->fFeatures
& FADF_VARIANT
)
963 VARIANT
* lpVariant
= (VARIANT
*)lpvSrc
;
964 VARIANT
* lpDest
= (VARIANT
*)pvData
;
966 /* The original content of pvData is ignored. */
967 V_VT(lpDest
) = VT_EMPTY
;
968 hRet
= VariantCopy(lpDest
, lpVariant
);
969 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%lx\n", hRet
);
971 else if (psa
->fFeatures
& FADF_BSTR
)
973 BSTR
* lpBstr
= (BSTR
*)lpvSrc
;
974 BSTR
* lpDest
= (BSTR
*)pvData
;
978 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
980 hRet
= E_OUTOFMEMORY
;
987 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
989 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)lpvSrc
;
992 IUnknown_AddRef(*lpUnknown
);
994 /* Copy the data over */
995 memcpy(pvData
, lpvSrc
, psa
->cbElements
);
998 SafeArrayUnlock(psa
);
1003 /*************************************************************************
1004 * SafeArrayGetUBound (OLEAUT32.19)
1006 * Get the upper bound for a given SafeArray dimension
1009 * psa [I] Array to get dimension upper bound from
1010 * nDim [I] The dimension number to get the upper bound of
1011 * plUbound [O] Destination for the upper bound
1014 * Success: S_OK. plUbound contains the dimensions upper bound.
1015 * Failure: An HRESULT error code indicating the error.
1020 HRESULT WINAPI
SafeArrayGetUBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plUbound
)
1022 TRACE("(%p,%d,%p)\n", psa
, nDim
, plUbound
);
1024 if (!psa
|| !plUbound
)
1025 return E_INVALIDARG
;
1027 if(!nDim
|| nDim
> psa
->cDims
)
1028 return DISP_E_BADINDEX
;
1030 *plUbound
= psa
->rgsabound
[nDim
- 1].lLbound
+
1031 psa
->rgsabound
[nDim
- 1].cElements
- 1;
1036 /*************************************************************************
1037 * SafeArrayGetLBound (OLEAUT32.20)
1039 * Get the lower bound for a given SafeArray dimension
1042 * psa [I] Array to get dimension lower bound from
1043 * nDim [I] The dimension number to get the lowe bound of
1044 * plLbound [O] Destination for the lower bound
1047 * Success: S_OK. plUbound contains the dimensions lower bound.
1048 * Failure: An HRESULT error code indicating the error.
1053 HRESULT WINAPI
SafeArrayGetLBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plLbound
)
1055 TRACE("(%p,%d,%p)\n", psa
, nDim
, plLbound
);
1057 if (!psa
|| !plLbound
)
1058 return E_INVALIDARG
;
1060 if(!nDim
|| nDim
> psa
->cDims
)
1061 return DISP_E_BADINDEX
;
1063 *plLbound
= psa
->rgsabound
[nDim
- 1].lLbound
;
1067 /*************************************************************************
1068 * SafeArrayGetDim (OLEAUT32.17)
1070 * Get the number of dimensions in a SafeArray.
1073 * psa [I] Array to get the dimensions of
1076 * The number of array dimensions in psa, or 0 if psa is NULL.
1081 UINT WINAPI
SafeArrayGetDim(SAFEARRAY
*psa
)
1083 TRACE("(%p) returning %ld\n", psa
, psa
? psa
->cDims
: 0ul);
1084 return psa
? psa
->cDims
: 0;
1087 /*************************************************************************
1088 * SafeArrayGetElemsize (OLEAUT32.18)
1090 * Get the size of an element in a SafeArray.
1093 * psa [I] Array to get the element size from
1096 * The size of a single element in psa, or 0 if psa is NULL.
1101 UINT WINAPI
SafeArrayGetElemsize(SAFEARRAY
*psa
)
1103 TRACE("(%p) returning %ld\n", psa
, psa
? psa
->cbElements
: 0ul);
1104 return psa
? psa
->cbElements
: 0;
1107 /*************************************************************************
1108 * SafeArrayAccessData (OLEAUT32.23)
1110 * Lock a SafeArray and return a pointer to its data.
1113 * psa [I] Array to get the data pointer from
1114 * ppvData [O] Destination for the arrays data pointer
1117 * Success: S_OK. ppvData contains the arrays data pointer, and the array
1119 * Failure: An HRESULT error code indicating the error.
1124 HRESULT WINAPI
SafeArrayAccessData(SAFEARRAY
*psa
, void **ppvData
)
1126 TRACE("(%p,%p)\n", psa
, ppvData
);
1128 if(!psa
|| !ppvData
)
1129 return E_INVALIDARG
;
1131 if (SUCCEEDED(SafeArrayLock(psa
)))
1133 *ppvData
= psa
->pvData
;
1137 return E_UNEXPECTED
;
1141 /*************************************************************************
1142 * SafeArrayUnaccessData (OLEAUT32.24)
1144 * Unlock a SafeArray after accessing its data.
1147 * psa [I] Array to unlock
1150 * Success: S_OK. The array is unlocked.
1151 * Failure: An HRESULT error code indicating the error.
1156 HRESULT WINAPI
SafeArrayUnaccessData(SAFEARRAY
*psa
)
1158 TRACE("(%p)\n", psa
);
1159 return SafeArrayUnlock(psa
);
1162 /************************************************************************
1163 * SafeArrayPtrOfIndex (OLEAUT32.148)
1165 * Get the address of an item in a SafeArray.
1168 * psa [I] Array to get the items address from
1169 * rgIndices [I] Index of the item in the array
1170 * ppvData [O] Destination for item address
1173 * Success: S_OK. ppvData contains a pointer to the item.
1174 * Failure: An HRESULT error code indicating the error.
1177 * This function does not lock the array.
1182 HRESULT WINAPI
SafeArrayPtrOfIndex(SAFEARRAY
*psa
, LONG
*rgIndices
, void **ppvData
)
1185 ULONG cell
= 0, dimensionSize
= 1;
1186 SAFEARRAYBOUND
* psab
;
1189 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, ppvData
);
1191 /* The general formula for locating the cell number of an entry in an n
1192 * dimensional array (where cn = coordinate in dimension dn) is:
1194 * c1 + c2 * sizeof(d1) + c3 * sizeof(d2) ... + cn * sizeof(c(n-1))
1196 * We calculate the size of the last dimension at each step through the
1197 * dimensions to avoid recursing to calculate the last dimensions size.
1199 if (!psa
|| !rgIndices
|| !ppvData
)
1200 return E_INVALIDARG
;
1202 psab
= psa
->rgsabound
;
1205 if (c1
< psab
->lLbound
|| c1
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1206 return DISP_E_BADINDEX
; /* Initial index out of bounds */
1208 for (dim
= 1; dim
< psa
->cDims
; dim
++)
1210 dimensionSize
*= psab
->cElements
;
1214 if (!psab
->cElements
||
1215 *rgIndices
< psab
->lLbound
||
1216 *rgIndices
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1217 return DISP_E_BADINDEX
; /* Index out of bounds */
1219 cell
+= (*rgIndices
- psab
->lLbound
) * dimensionSize
;
1223 cell
+= (c1
- psa
->rgsabound
[0].lLbound
);
1225 *ppvData
= (char*)psa
->pvData
+ cell
* psa
->cbElements
;
1229 /************************************************************************
1230 * SafeArrayDestroyData (OLEAUT32.39)
1232 * Destroy the data associated with a SafeArray.
1235 * psa [I] Array to delete the data from
1238 * Success: S_OK. All items and the item data are freed.
1239 * Failure: An HRESULT error code indicating the error.
1244 HRESULT WINAPI
SafeArrayDestroyData(SAFEARRAY
*psa
)
1246 TRACE("(%p)\n", psa
);
1249 return E_INVALIDARG
;
1252 return DISP_E_ARRAYISLOCKED
; /* Can't delete a locked array */
1254 /* If static, keep pvData and don't free */
1255 if (psa
->pvData
&& !(psa
->fFeatures
& FADF_STATIC
))
1257 /* Delete the actual item data */
1258 if (FAILED(SAFEARRAY_DestroyData(psa
, 0)))
1259 return E_UNEXPECTED
;
1261 /* If this is not a vector, free the data memory block */
1262 if (!(psa
->fFeatures
& FADF_CREATEVECTOR
))
1264 if (!SAFEARRAY_Free(psa
->pvData
))
1265 return E_UNEXPECTED
;
1269 psa
->fFeatures
|= FADF_DATADELETED
; /* Mark the data deleted */
1275 /************************************************************************
1276 * SafeArrayCopyData (OLEAUT32.412)
1278 * Copy all data from one SafeArray to another.
1281 * psaSource [I] Source for copy
1282 * psaTarget [O] Destination for copy
1285 * Success: S_OK. psaTarget contains a copy of psaSource.
1286 * Failure: An HRESULT error code indicating the error.
1289 * The two arrays must have the same number of dimensions and elements.
1294 HRESULT WINAPI
SafeArrayCopyData(SAFEARRAY
*psaSource
, SAFEARRAY
*psaTarget
)
1298 TRACE("(%p,%p)\n", psaSource
, psaTarget
);
1300 if (!psaSource
|| !psaTarget
||
1301 psaSource
->cDims
!= psaTarget
->cDims
||
1302 psaSource
->cbElements
!= psaTarget
->cbElements
)
1303 return E_INVALIDARG
;
1305 /* Each dimension must be the same size */
1306 for (dim
= psaSource
->cDims
- 1; dim
>= 0 ; dim
--)
1307 if (psaSource
->rgsabound
[dim
].cElements
!=
1308 psaTarget
->rgsabound
[dim
].cElements
)
1309 return E_INVALIDARG
;
1311 if (SUCCEEDED(SAFEARRAY_DestroyData(psaTarget
, 0)) &&
1312 SUCCEEDED(SAFEARRAY_CopyData(psaSource
, psaTarget
)))
1314 return E_UNEXPECTED
;
1317 /************************************************************************
1318 * SafeArrayDestroy (OLEAUT32.16)
1320 * Destroy a SafeArray.
1323 * psa [I] Array to destroy
1326 * Success: S_OK. All resources used by the array are freed.
1327 * Failure: An HRESULT error code indicating the error.
1332 HRESULT WINAPI
SafeArrayDestroy(SAFEARRAY
*psa
)
1334 TRACE("(%p)\n", psa
);
1340 return DISP_E_ARRAYISLOCKED
;
1342 /* Native doesn't check to see if the free succeeds */
1343 SafeArrayDestroyData(psa
);
1344 SafeArrayDestroyDescriptor(psa
);
1348 /************************************************************************
1349 * SafeArrayCopy (OLEAUT32.27)
1351 * Make a duplicate of a SafeArray.
1354 * psa [I] Source for copy
1355 * ppsaOut [O] Destination for new copy
1358 * Success: S_OK. ppsaOut contains a copy of the array.
1359 * Failure: An HRESULT error code indicating the error.
1364 HRESULT WINAPI
SafeArrayCopy(SAFEARRAY
*psa
, SAFEARRAY
**ppsaOut
)
1368 TRACE("(%p,%p)\n", psa
, ppsaOut
);
1371 return E_INVALIDARG
;
1376 return S_OK
; /* Handles copying of NULL arrays */
1378 if (!psa
->cbElements
)
1380 ERR("not copying an array of 0 elements\n");
1381 return E_INVALIDARG
;
1384 if (psa
->fFeatures
& (FADF_RECORD
|FADF_HAVEIID
|FADF_HAVEVARTYPE
))
1387 if (FAILED(SafeArrayGetVartype(psa
, &vt
)))
1388 hRet
= E_UNEXPECTED
;
1390 hRet
= SafeArrayAllocDescriptorEx(vt
, psa
->cDims
, ppsaOut
);
1394 hRet
= SafeArrayAllocDescriptor(psa
->cDims
, ppsaOut
);
1395 if (SUCCEEDED(hRet
))
1397 (*ppsaOut
)->fFeatures
= psa
->fFeatures
& ~FADF_CREATEVECTOR
;
1398 (*ppsaOut
)->cbElements
= psa
->cbElements
;
1402 if (SUCCEEDED(hRet
))
1404 /* Copy dimension bounds */
1405 memcpy((*ppsaOut
)->rgsabound
, psa
->rgsabound
, psa
->cDims
* sizeof(SAFEARRAYBOUND
));
1407 (*ppsaOut
)->pvData
= SAFEARRAY_Malloc(SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
);
1409 if ((*ppsaOut
)->pvData
)
1411 hRet
= SAFEARRAY_CopyData(psa
, *ppsaOut
);
1413 if (SUCCEEDED(hRet
))
1416 SAFEARRAY_Free((*ppsaOut
)->pvData
);
1418 SafeArrayDestroyDescriptor(*ppsaOut
);
1424 /************************************************************************
1425 * SafeArrayRedim (OLEAUT32.40)
1427 * Changes the characteristics of the last dimension of a SafeArray
1430 * psa [I] Array to change
1431 * psabound [I] New bound details for the last dimension
1434 * Success: S_OK. psa is updated to reflect the new bounds.
1435 * Failure: An HRESULT error code indicating the error.
1440 HRESULT WINAPI
SafeArrayRedim(SAFEARRAY
*psa
, SAFEARRAYBOUND
*psabound
)
1442 SAFEARRAYBOUND
*oldBounds
;
1444 TRACE("(%p,%p)\n", psa
, psabound
);
1446 if (!psa
|| psa
->fFeatures
& FADF_FIXEDSIZE
|| !psabound
)
1447 return E_INVALIDARG
;
1449 if (psa
->cLocks
> 0)
1450 return DISP_E_ARRAYISLOCKED
;
1452 if (FAILED(SafeArrayLock(psa
)))
1453 return E_UNEXPECTED
;
1455 oldBounds
= &psa
->rgsabound
[psa
->cDims
- 1];
1456 oldBounds
->lLbound
= psabound
->lLbound
;
1458 if (psabound
->cElements
!= oldBounds
->cElements
)
1460 if (psabound
->cElements
< oldBounds
->cElements
)
1462 /* Shorten the final dimension. */
1463 ULONG ulStartCell
= psa
->cDims
== 1 ? 0 : SAFEARRAY_GetDimensionCells(psa
, psa
->cDims
- 1);
1465 ulStartCell
+= psabound
->cElements
;
1466 SAFEARRAY_DestroyData(psa
, ulStartCell
);
1470 /* Lengthen the final dimension */
1471 ULONG ulOldSize
, ulNewSize
;
1474 ulOldSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1476 ulNewSize
= (ulOldSize
/ oldBounds
->cElements
) * psabound
->cElements
;
1478 int oldelems
= oldBounds
->cElements
;
1479 oldBounds
->cElements
= psabound
->cElements
;
1480 ulNewSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1481 oldBounds
->cElements
= oldelems
;
1484 if (!(pvNewData
= SAFEARRAY_Malloc(ulNewSize
)))
1486 SafeArrayUnlock(psa
);
1487 return E_UNEXPECTED
;
1490 memcpy(pvNewData
, psa
->pvData
, ulOldSize
);
1491 SAFEARRAY_Free(psa
->pvData
);
1492 psa
->pvData
= pvNewData
;
1494 oldBounds
->cElements
= psabound
->cElements
;
1497 SafeArrayUnlock(psa
);
1501 /************************************************************************
1502 * SafeArrayGetVartype (OLEAUT32.77)
1504 * Get the type of the items in a SafeArray.
1507 * psa [I] Array to get the type from
1508 * pvt [O] Destination for the type
1511 * Success: S_OK. pvt contains the type of the items.
1512 * Failure: An HRESULT error code indicating the error.
1517 HRESULT WINAPI
SafeArrayGetVartype(SAFEARRAY
* psa
, VARTYPE
* pvt
)
1519 TRACE("(%p,%p)\n", psa
, pvt
);
1522 return E_INVALIDARG
;
1524 if (psa
->fFeatures
& FADF_RECORD
)
1526 else if (psa
->fFeatures
& FADF_HAVEIID
)
1528 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
1530 VARTYPE vt
= SAFEARRAY_GetHiddenDWORD(psa
);
1534 return E_INVALIDARG
;
1539 /************************************************************************
1540 * SafeArraySetRecordInfo (OLEAUT32.@)
1542 * Set the record info for a SafeArray.
1545 * psa [I] Array to set the record info for
1546 * pRinfo [I] Record info
1549 * Success: S_OK. The record info is stored with the array.
1550 * Failure: An HRESULT error code indicating the error.
1555 HRESULT WINAPI
SafeArraySetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
*pRinfo
)
1557 IRecordInfo
** dest
= (IRecordInfo
**)psa
;
1559 TRACE("(%p,%p)\n", psa
, pRinfo
);
1561 if (!psa
|| !(psa
->fFeatures
& FADF_RECORD
))
1562 return E_INVALIDARG
;
1565 IRecordInfo_AddRef(pRinfo
);
1568 IRecordInfo_Release(dest
[-1]);
1574 /************************************************************************
1575 * SafeArrayGetRecordInfo (OLEAUT32.@)
1577 * Get the record info from a SafeArray.
1580 * psa [I] Array to get the record info from
1581 * pRinfo [O] Destination for the record info
1584 * Success: S_OK. pRinfo contains the record info, or NULL if there was none.
1585 * Failure: An HRESULT error code indicating the error.
1590 HRESULT WINAPI
SafeArrayGetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
**pRinfo
)
1592 IRecordInfo
** src
= (IRecordInfo
**)psa
;
1594 TRACE("(%p,%p)\n", psa
, pRinfo
);
1596 if (!psa
|| !pRinfo
|| !(psa
->fFeatures
& FADF_RECORD
))
1597 return E_INVALIDARG
;
1602 IRecordInfo_AddRef(*pRinfo
);
1606 /************************************************************************
1607 * SafeArraySetIID (OLEAUT32.@)
1609 * Set the IID for a SafeArray.
1612 * psa [I] Array to set the IID from
1616 * Success: S_OK. The IID is stored with the array
1617 * Failure: An HRESULT error code indicating the error.
1622 HRESULT WINAPI
SafeArraySetIID(SAFEARRAY
*psa
, REFGUID guid
)
1624 GUID
* dest
= (GUID
*)psa
;
1626 TRACE("(%p,%s)\n", psa
, debugstr_guid(guid
));
1628 if (!psa
|| !guid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1629 return E_INVALIDARG
;
1635 /************************************************************************
1636 * SafeArrayGetIID (OLEAUT32.@)
1638 * Get the IID from a SafeArray.
1641 * psa [I] Array to get the ID from
1642 * pGuid [O] Destination for the IID
1645 * Success: S_OK. pRinfo contains the IID, or NULL if there was none.
1646 * Failure: An HRESULT error code indicating the error.
1651 HRESULT WINAPI
SafeArrayGetIID(SAFEARRAY
*psa
, GUID
*pGuid
)
1653 GUID
* src
= (GUID
*)psa
;
1655 TRACE("(%p,%p)\n", psa
, pGuid
);
1657 if (!psa
|| !pGuid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1658 return E_INVALIDARG
;
1664 /************************************************************************
1665 * VectorFromBstr (OLEAUT32.@)
1667 * Create a SafeArray Vector from the bytes of a BSTR.
1670 * bstr [I] String to get bytes from
1671 * ppsa [O] Destination for the array
1674 * Success: S_OK. ppsa contains the strings bytes as a VT_UI1 array.
1675 * Failure: An HRESULT error code indicating the error.
1680 HRESULT WINAPI
VectorFromBstr(BSTR bstr
, SAFEARRAY
**ppsa
)
1684 TRACE("(%p,%p)\n", bstr
, ppsa
);
1687 return E_INVALIDARG
;
1690 sab
.cElements
= SysStringByteLen(bstr
);
1692 *ppsa
= SAFEARRAY_Create(VT_UI1
, 1, &sab
, 0);
1696 memcpy((*ppsa
)->pvData
, bstr
, sab
.cElements
);
1699 return E_OUTOFMEMORY
;
1702 /************************************************************************
1703 * BstrFromVector (OLEAUT32.@)
1705 * Create a BSTR from a SafeArray.
1708 * psa [I] Source array
1709 * pbstr [O] Destination for output BSTR
1712 * Success: S_OK. pbstr contains the arrays data.
1713 * Failure: An HRESULT error code indicating the error.
1716 * psa must be a 1 dimensional array of a 1 byte type.
1721 HRESULT WINAPI
BstrFromVector(SAFEARRAY
*psa
, BSTR
*pbstr
)
1723 TRACE("(%p,%p)\n", psa
, pbstr
);
1726 return E_INVALIDARG
;
1730 if (!psa
|| psa
->cbElements
!= 1 || psa
->cDims
!= 1)
1731 return E_INVALIDARG
;
1733 *pbstr
= SysAllocStringByteLen(psa
->pvData
, psa
->rgsabound
[0].cElements
);
1735 return E_OUTOFMEMORY
;