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...]
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
);
899 *lpDest
= SysAllocStringByteLen((char*)lpBstr
, SysStringByteLen(lpBstr
));
901 hRet
= E_OUTOFMEMORY
;
908 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
910 LPUNKNOWN lpUnknown
= (LPUNKNOWN
)pvData
;
911 LPUNKNOWN
*lpDest
= (LPUNKNOWN
*)lpvDest
;
914 IUnknown_AddRef(lpUnknown
);
916 IUnknown_Release(*lpDest
);
919 /* Copy the data over */
920 memcpy(lpvDest
, pvData
, psa
->cbElements
);
924 SafeArrayUnlock(psa
);
930 /*************************************************************************
931 * SafeArrayGetElement (OLEAUT32.25)
933 * Get an item from a SafeArray.
936 * psa [I] SafeArray to get from
937 * rgIndices [I] Indices to get from
938 * pvData [O] Destination for data
941 * Success: S_OK. The item data is returned in pvData.
942 * Failure: An HRESULT error code indicating the error.
947 HRESULT WINAPI
SafeArrayGetElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
951 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
953 if (!psa
|| !rgIndices
|| !pvData
)
956 hRet
= SafeArrayLock(psa
);
962 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvSrc
);
966 if (psa
->fFeatures
& FADF_VARIANT
)
968 VARIANT
* lpVariant
= (VARIANT
*)lpvSrc
;
969 VARIANT
* lpDest
= (VARIANT
*)pvData
;
971 /* The original content of pvData is ignored. */
972 V_VT(lpDest
) = VT_EMPTY
;
973 hRet
= VariantCopy(lpDest
, lpVariant
);
974 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%lx\n", hRet
);
976 else if (psa
->fFeatures
& FADF_BSTR
)
978 BSTR
* lpBstr
= (BSTR
*)lpvSrc
;
979 BSTR
* lpDest
= (BSTR
*)pvData
;
983 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
985 hRet
= E_OUTOFMEMORY
;
992 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
994 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)lpvSrc
;
997 IUnknown_AddRef(*lpUnknown
);
999 /* Copy the data over */
1000 memcpy(pvData
, lpvSrc
, psa
->cbElements
);
1003 SafeArrayUnlock(psa
);
1008 /*************************************************************************
1009 * SafeArrayGetUBound (OLEAUT32.19)
1011 * Get the upper bound for a given SafeArray dimension
1014 * psa [I] Array to get dimension upper bound from
1015 * nDim [I] The dimension number to get the upper bound of
1016 * plUbound [O] Destination for the upper bound
1019 * Success: S_OK. plUbound contains the dimensions upper bound.
1020 * Failure: An HRESULT error code indicating the error.
1025 HRESULT WINAPI
SafeArrayGetUBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plUbound
)
1027 TRACE("(%p,%d,%p)\n", psa
, nDim
, plUbound
);
1029 if (!psa
|| !plUbound
)
1030 return E_INVALIDARG
;
1032 if(!nDim
|| nDim
> psa
->cDims
)
1033 return DISP_E_BADINDEX
;
1035 *plUbound
= psa
->rgsabound
[nDim
- 1].lLbound
+
1036 psa
->rgsabound
[nDim
- 1].cElements
- 1;
1041 /*************************************************************************
1042 * SafeArrayGetLBound (OLEAUT32.20)
1044 * Get the lower bound for a given SafeArray dimension
1047 * psa [I] Array to get dimension lower bound from
1048 * nDim [I] The dimension number to get the lowe bound of
1049 * plLbound [O] Destination for the lower bound
1052 * Success: S_OK. plUbound contains the dimensions lower bound.
1053 * Failure: An HRESULT error code indicating the error.
1058 HRESULT WINAPI
SafeArrayGetLBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plLbound
)
1060 TRACE("(%p,%d,%p)\n", psa
, nDim
, plLbound
);
1062 if (!psa
|| !plLbound
)
1063 return E_INVALIDARG
;
1065 if(!nDim
|| nDim
> psa
->cDims
)
1066 return DISP_E_BADINDEX
;
1068 *plLbound
= psa
->rgsabound
[nDim
- 1].lLbound
;
1072 /*************************************************************************
1073 * SafeArrayGetDim (OLEAUT32.17)
1075 * Get the number of dimensions in a SafeArray.
1078 * psa [I] Array to get the dimensions of
1081 * The number of array dimensions in psa, or 0 if psa is NULL.
1086 UINT WINAPI
SafeArrayGetDim(SAFEARRAY
*psa
)
1088 TRACE("(%p) returning %ld\n", psa
, psa
? psa
->cDims
: 0ul);
1089 return psa
? psa
->cDims
: 0;
1092 /*************************************************************************
1093 * SafeArrayGetElemsize (OLEAUT32.18)
1095 * Get the size of an element in a SafeArray.
1098 * psa [I] Array to get the element size from
1101 * The size of a single element in psa, or 0 if psa is NULL.
1106 UINT WINAPI
SafeArrayGetElemsize(SAFEARRAY
*psa
)
1108 TRACE("(%p) returning %ld\n", psa
, psa
? psa
->cbElements
: 0ul);
1109 return psa
? psa
->cbElements
: 0;
1112 /*************************************************************************
1113 * SafeArrayAccessData (OLEAUT32.23)
1115 * Lock a SafeArray and return a pointer to its data.
1118 * psa [I] Array to get the data pointer from
1119 * ppvData [O] Destination for the arrays data pointer
1122 * Success: S_OK. ppvData contains the arrays data pointer, and the array
1124 * Failure: An HRESULT error code indicating the error.
1129 HRESULT WINAPI
SafeArrayAccessData(SAFEARRAY
*psa
, void **ppvData
)
1131 TRACE("(%p,%p)\n", psa
, ppvData
);
1133 if(!psa
|| !ppvData
)
1134 return E_INVALIDARG
;
1136 if (SUCCEEDED(SafeArrayLock(psa
)))
1138 *ppvData
= psa
->pvData
;
1142 return E_UNEXPECTED
;
1146 /*************************************************************************
1147 * SafeArrayUnaccessData (OLEAUT32.24)
1149 * Unlock a SafeArray after accessing its data.
1152 * psa [I] Array to unlock
1155 * Success: S_OK. The array is unlocked.
1156 * Failure: An HRESULT error code indicating the error.
1161 HRESULT WINAPI
SafeArrayUnaccessData(SAFEARRAY
*psa
)
1163 TRACE("(%p)\n", psa
);
1164 return SafeArrayUnlock(psa
);
1167 /************************************************************************
1168 * SafeArrayPtrOfIndex (OLEAUT32.148)
1170 * Get the address of an item in a SafeArray.
1173 * psa [I] Array to get the items address from
1174 * rgIndices [I] Index of the item in the array
1175 * ppvData [O] Destination for item address
1178 * Success: S_OK. ppvData contains a pointer to the item.
1179 * Failure: An HRESULT error code indicating the error.
1182 * This function does not lock the array.
1187 HRESULT WINAPI
SafeArrayPtrOfIndex(SAFEARRAY
*psa
, LONG
*rgIndices
, void **ppvData
)
1190 ULONG cell
= 0, dimensionSize
= 1;
1191 SAFEARRAYBOUND
* psab
;
1194 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, ppvData
);
1196 /* The general formula for locating the cell number of an entry in an n
1197 * dimensional array (where cn = coordinate in dimension dn) is:
1199 * c1 + c2 * sizeof(d1) + c3 * sizeof(d2) ... + cn * sizeof(c(n-1))
1201 * We calculate the size of the last dimension at each step through the
1202 * dimensions to avoid recursing to calculate the last dimensions size.
1204 if (!psa
|| !rgIndices
|| !ppvData
)
1205 return E_INVALIDARG
;
1207 psab
= psa
->rgsabound
;
1210 if (c1
< psab
->lLbound
|| c1
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1211 return DISP_E_BADINDEX
; /* Initial index out of bounds */
1213 for (dim
= 1; dim
< psa
->cDims
; dim
++)
1215 dimensionSize
*= psab
->cElements
;
1219 if (!psab
->cElements
||
1220 *rgIndices
< psab
->lLbound
||
1221 *rgIndices
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1222 return DISP_E_BADINDEX
; /* Index out of bounds */
1224 cell
+= (*rgIndices
- psab
->lLbound
) * dimensionSize
;
1228 cell
+= (c1
- psa
->rgsabound
[0].lLbound
);
1230 *ppvData
= (char*)psa
->pvData
+ cell
* psa
->cbElements
;
1234 /************************************************************************
1235 * SafeArrayDestroyData (OLEAUT32.39)
1237 * Destroy the data associated with a SafeArray.
1240 * psa [I] Array to delete the data from
1243 * Success: S_OK. All items and the item data are freed.
1244 * Failure: An HRESULT error code indicating the error.
1249 HRESULT WINAPI
SafeArrayDestroyData(SAFEARRAY
*psa
)
1251 TRACE("(%p)\n", psa
);
1254 return E_INVALIDARG
;
1257 return DISP_E_ARRAYISLOCKED
; /* Can't delete a locked array */
1259 /* If static, keep pvData and don't free */
1260 if (psa
->pvData
&& !(psa
->fFeatures
& FADF_STATIC
))
1262 /* Delete the actual item data */
1263 if (FAILED(SAFEARRAY_DestroyData(psa
, 0)))
1264 return E_UNEXPECTED
;
1266 /* If this is not a vector, free the data memory block */
1267 if (!(psa
->fFeatures
& FADF_CREATEVECTOR
))
1269 if (!SAFEARRAY_Free(psa
->pvData
))
1270 return E_UNEXPECTED
;
1274 psa
->fFeatures
|= FADF_DATADELETED
; /* Mark the data deleted */
1280 /************************************************************************
1281 * SafeArrayCopyData (OLEAUT32.412)
1283 * Copy all data from one SafeArray to another.
1286 * psaSource [I] Source for copy
1287 * psaTarget [O] Destination for copy
1290 * Success: S_OK. psaTarget contains a copy of psaSource.
1291 * Failure: An HRESULT error code indicating the error.
1294 * The two arrays must have the same number of dimensions and elements.
1299 HRESULT WINAPI
SafeArrayCopyData(SAFEARRAY
*psaSource
, SAFEARRAY
*psaTarget
)
1303 TRACE("(%p,%p)\n", psaSource
, psaTarget
);
1305 if (!psaSource
|| !psaTarget
||
1306 psaSource
->cDims
!= psaTarget
->cDims
||
1307 psaSource
->cbElements
!= psaTarget
->cbElements
)
1308 return E_INVALIDARG
;
1310 /* Each dimension must be the same size */
1311 for (dim
= psaSource
->cDims
- 1; dim
>= 0 ; dim
--)
1312 if (psaSource
->rgsabound
[dim
].cElements
!=
1313 psaTarget
->rgsabound
[dim
].cElements
)
1314 return E_INVALIDARG
;
1316 if (SUCCEEDED(SAFEARRAY_DestroyData(psaTarget
, 0)) &&
1317 SUCCEEDED(SAFEARRAY_CopyData(psaSource
, psaTarget
)))
1319 return E_UNEXPECTED
;
1322 /************************************************************************
1323 * SafeArrayDestroy (OLEAUT32.16)
1325 * Destroy a SafeArray.
1328 * psa [I] Array to destroy
1331 * Success: S_OK. All resources used by the array are freed.
1332 * Failure: An HRESULT error code indicating the error.
1337 HRESULT WINAPI
SafeArrayDestroy(SAFEARRAY
*psa
)
1339 TRACE("(%p)\n", psa
);
1345 return DISP_E_ARRAYISLOCKED
;
1347 /* Native doesn't check to see if the free succeeds */
1348 SafeArrayDestroyData(psa
);
1349 SafeArrayDestroyDescriptor(psa
);
1353 /************************************************************************
1354 * SafeArrayCopy (OLEAUT32.27)
1356 * Make a duplicate of a SafeArray.
1359 * psa [I] Source for copy
1360 * ppsaOut [O] Destination for new copy
1363 * Success: S_OK. ppsaOut contains a copy of the array.
1364 * Failure: An HRESULT error code indicating the error.
1369 HRESULT WINAPI
SafeArrayCopy(SAFEARRAY
*psa
, SAFEARRAY
**ppsaOut
)
1373 TRACE("(%p,%p)\n", psa
, ppsaOut
);
1376 return E_INVALIDARG
;
1381 return S_OK
; /* Handles copying of NULL arrays */
1383 if (!psa
->cbElements
)
1385 ERR("not copying an array of 0 elements\n");
1386 return E_INVALIDARG
;
1389 if (psa
->fFeatures
& (FADF_RECORD
|FADF_HAVEIID
|FADF_HAVEVARTYPE
))
1392 if (FAILED(SafeArrayGetVartype(psa
, &vt
)))
1393 hRet
= E_UNEXPECTED
;
1395 hRet
= SafeArrayAllocDescriptorEx(vt
, psa
->cDims
, ppsaOut
);
1399 hRet
= SafeArrayAllocDescriptor(psa
->cDims
, ppsaOut
);
1400 if (SUCCEEDED(hRet
))
1402 (*ppsaOut
)->fFeatures
= psa
->fFeatures
& ~FADF_CREATEVECTOR
;
1403 (*ppsaOut
)->cbElements
= psa
->cbElements
;
1407 if (SUCCEEDED(hRet
))
1409 /* Copy dimension bounds */
1410 memcpy((*ppsaOut
)->rgsabound
, psa
->rgsabound
, psa
->cDims
* sizeof(SAFEARRAYBOUND
));
1412 (*ppsaOut
)->pvData
= SAFEARRAY_Malloc(SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
);
1414 if ((*ppsaOut
)->pvData
)
1416 hRet
= SAFEARRAY_CopyData(psa
, *ppsaOut
);
1418 if (SUCCEEDED(hRet
))
1421 SAFEARRAY_Free((*ppsaOut
)->pvData
);
1423 SafeArrayDestroyDescriptor(*ppsaOut
);
1429 /************************************************************************
1430 * SafeArrayRedim (OLEAUT32.40)
1432 * Changes the characteristics of the last dimension of a SafeArray
1435 * psa [I] Array to change
1436 * psabound [I] New bound details for the last dimension
1439 * Success: S_OK. psa is updated to reflect the new bounds.
1440 * Failure: An HRESULT error code indicating the error.
1445 HRESULT WINAPI
SafeArrayRedim(SAFEARRAY
*psa
, SAFEARRAYBOUND
*psabound
)
1447 SAFEARRAYBOUND
*oldBounds
;
1449 TRACE("(%p,%p)\n", psa
, psabound
);
1451 if (!psa
|| psa
->fFeatures
& FADF_FIXEDSIZE
|| !psabound
)
1452 return E_INVALIDARG
;
1454 if (psa
->cLocks
> 0)
1455 return DISP_E_ARRAYISLOCKED
;
1457 if (FAILED(SafeArrayLock(psa
)))
1458 return E_UNEXPECTED
;
1460 oldBounds
= &psa
->rgsabound
[psa
->cDims
- 1];
1461 oldBounds
->lLbound
= psabound
->lLbound
;
1463 if (psabound
->cElements
!= oldBounds
->cElements
)
1465 if (psabound
->cElements
< oldBounds
->cElements
)
1467 /* Shorten the final dimension. */
1468 ULONG ulStartCell
= psa
->cDims
== 1 ? 0 : SAFEARRAY_GetDimensionCells(psa
, psa
->cDims
- 1);
1470 ulStartCell
+= psabound
->cElements
;
1471 SAFEARRAY_DestroyData(psa
, ulStartCell
);
1475 /* Lengthen the final dimension */
1476 ULONG ulOldSize
, ulNewSize
;
1479 ulOldSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1481 ulNewSize
= (ulOldSize
/ oldBounds
->cElements
) * psabound
->cElements
;
1483 int oldelems
= oldBounds
->cElements
;
1484 oldBounds
->cElements
= psabound
->cElements
;
1485 ulNewSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1486 oldBounds
->cElements
= oldelems
;
1489 if (!(pvNewData
= SAFEARRAY_Malloc(ulNewSize
)))
1491 SafeArrayUnlock(psa
);
1492 return E_UNEXPECTED
;
1495 memcpy(pvNewData
, psa
->pvData
, ulOldSize
);
1496 SAFEARRAY_Free(psa
->pvData
);
1497 psa
->pvData
= pvNewData
;
1499 oldBounds
->cElements
= psabound
->cElements
;
1502 SafeArrayUnlock(psa
);
1506 /************************************************************************
1507 * SafeArrayGetVartype (OLEAUT32.77)
1509 * Get the type of the items in a SafeArray.
1512 * psa [I] Array to get the type from
1513 * pvt [O] Destination for the type
1516 * Success: S_OK. pvt contains the type of the items.
1517 * Failure: An HRESULT error code indicating the error.
1522 HRESULT WINAPI
SafeArrayGetVartype(SAFEARRAY
* psa
, VARTYPE
* pvt
)
1524 TRACE("(%p,%p)\n", psa
, pvt
);
1527 return E_INVALIDARG
;
1529 if (psa
->fFeatures
& FADF_RECORD
)
1531 else if (psa
->fFeatures
& FADF_HAVEIID
)
1533 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
1535 VARTYPE vt
= SAFEARRAY_GetHiddenDWORD(psa
);
1539 return E_INVALIDARG
;
1544 /************************************************************************
1545 * SafeArraySetRecordInfo (OLEAUT32.@)
1547 * Set the record info for a SafeArray.
1550 * psa [I] Array to set the record info for
1551 * pRinfo [I] Record info
1554 * Success: S_OK. The record info is stored with the array.
1555 * Failure: An HRESULT error code indicating the error.
1560 HRESULT WINAPI
SafeArraySetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
*pRinfo
)
1562 IRecordInfo
** dest
= (IRecordInfo
**)psa
;
1564 TRACE("(%p,%p)\n", psa
, pRinfo
);
1566 if (!psa
|| !(psa
->fFeatures
& FADF_RECORD
))
1567 return E_INVALIDARG
;
1570 IRecordInfo_AddRef(pRinfo
);
1573 IRecordInfo_Release(dest
[-1]);
1579 /************************************************************************
1580 * SafeArrayGetRecordInfo (OLEAUT32.@)
1582 * Get the record info from a SafeArray.
1585 * psa [I] Array to get the record info from
1586 * pRinfo [O] Destination for the record info
1589 * Success: S_OK. pRinfo contains the record info, or NULL if there was none.
1590 * Failure: An HRESULT error code indicating the error.
1595 HRESULT WINAPI
SafeArrayGetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
**pRinfo
)
1597 IRecordInfo
** src
= (IRecordInfo
**)psa
;
1599 TRACE("(%p,%p)\n", psa
, pRinfo
);
1601 if (!psa
|| !pRinfo
|| !(psa
->fFeatures
& FADF_RECORD
))
1602 return E_INVALIDARG
;
1607 IRecordInfo_AddRef(*pRinfo
);
1611 /************************************************************************
1612 * SafeArraySetIID (OLEAUT32.@)
1614 * Set the IID for a SafeArray.
1617 * psa [I] Array to set the IID from
1621 * Success: S_OK. The IID is stored with the array
1622 * Failure: An HRESULT error code indicating the error.
1627 HRESULT WINAPI
SafeArraySetIID(SAFEARRAY
*psa
, REFGUID guid
)
1629 GUID
* dest
= (GUID
*)psa
;
1631 TRACE("(%p,%s)\n", psa
, debugstr_guid(guid
));
1633 if (!psa
|| !guid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1634 return E_INVALIDARG
;
1640 /************************************************************************
1641 * SafeArrayGetIID (OLEAUT32.@)
1643 * Get the IID from a SafeArray.
1646 * psa [I] Array to get the ID from
1647 * pGuid [O] Destination for the IID
1650 * Success: S_OK. pRinfo contains the IID, or NULL if there was none.
1651 * Failure: An HRESULT error code indicating the error.
1656 HRESULT WINAPI
SafeArrayGetIID(SAFEARRAY
*psa
, GUID
*pGuid
)
1658 GUID
* src
= (GUID
*)psa
;
1660 TRACE("(%p,%p)\n", psa
, pGuid
);
1662 if (!psa
|| !pGuid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1663 return E_INVALIDARG
;
1669 /************************************************************************
1670 * VectorFromBstr (OLEAUT32.@)
1672 * Create a SafeArray Vector from the bytes of a BSTR.
1675 * bstr [I] String to get bytes from
1676 * ppsa [O] Destination for the array
1679 * Success: S_OK. ppsa contains the strings bytes as a VT_UI1 array.
1680 * Failure: An HRESULT error code indicating the error.
1685 HRESULT WINAPI
VectorFromBstr(BSTR bstr
, SAFEARRAY
**ppsa
)
1689 TRACE("(%p,%p)\n", bstr
, ppsa
);
1692 return E_INVALIDARG
;
1695 sab
.cElements
= SysStringByteLen(bstr
);
1697 *ppsa
= SAFEARRAY_Create(VT_UI1
, 1, &sab
, 0);
1701 memcpy((*ppsa
)->pvData
, bstr
, sab
.cElements
);
1704 return E_OUTOFMEMORY
;
1707 /************************************************************************
1708 * BstrFromVector (OLEAUT32.@)
1710 * Create a BSTR from a SafeArray.
1713 * psa [I] Source array
1714 * pbstr [O] Destination for output BSTR
1717 * Success: S_OK. pbstr contains the arrays data.
1718 * Failure: An HRESULT error code indicating the error.
1721 * psa must be a 1 dimensional array of a 1 byte type.
1726 HRESULT WINAPI
BstrFromVector(SAFEARRAY
*psa
, BSTR
*pbstr
)
1728 TRACE("(%p,%p)\n", psa
, pbstr
);
1731 return E_INVALIDARG
;
1735 if (!psa
|| psa
->cbElements
!= 1 || psa
->cDims
!= 1)
1736 return E_INVALIDARG
;
1738 *pbstr
= SysAllocStringByteLen(psa
->pvData
, psa
->rgsabound
[0].cElements
);
1740 return E_OUTOFMEMORY
;