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 char *ptr
= SAFEARRAY_Malloc(ulSize
+ SAFEARRAY_HIDDEN_SIZE
);
183 *ppsaOut
= (SAFEARRAY
*)(ptr
+ SAFEARRAY_HIDDEN_SIZE
);
187 /* Set the features of an array */
188 static void SAFEARRAY_SetFeatures(VARTYPE vt
, SAFEARRAY
*psa
)
190 /* Set the IID if we have one, otherwise set the type */
191 if (vt
== VT_DISPATCH
)
193 psa
->fFeatures
= FADF_HAVEIID
;
194 SafeArraySetIID(psa
, &IID_IDispatch
);
196 else if (vt
== VT_UNKNOWN
)
198 psa
->fFeatures
= FADF_HAVEIID
;
199 SafeArraySetIID(psa
, &IID_IUnknown
);
201 else if (vt
== VT_RECORD
)
202 psa
->fFeatures
= FADF_RECORD
;
205 psa
->fFeatures
= FADF_HAVEVARTYPE
;
206 SAFEARRAY_SetHiddenDWORD(psa
, vt
);
210 /* Create an array */
211 static SAFEARRAY
* SAFEARRAY_Create(VARTYPE vt
, UINT cDims
, const SAFEARRAYBOUND
*rgsabound
, ULONG ulSize
)
213 SAFEARRAY
*psa
= NULL
;
219 if (SUCCEEDED(SafeArrayAllocDescriptorEx(vt
, cDims
, &psa
)))
223 case VT_BSTR
: psa
->fFeatures
|= FADF_BSTR
; break;
224 case VT_UNKNOWN
: psa
->fFeatures
|= FADF_UNKNOWN
; break;
225 case VT_DISPATCH
: psa
->fFeatures
|= FADF_DISPATCH
; break;
226 case VT_VARIANT
: psa
->fFeatures
|= FADF_VARIANT
; break;
229 for (i
= 0; i
< cDims
; i
++)
230 memcpy(psa
->rgsabound
+ i
, rgsabound
+ cDims
- 1 - i
, sizeof(SAFEARRAYBOUND
));
233 psa
->cbElements
= ulSize
;
235 if (!psa
->cbElements
|| FAILED(SafeArrayAllocData(psa
)))
237 SafeArrayDestroyDescriptor(psa
);
244 /* Create an array as a vector */
245 static SAFEARRAY
* SAFEARRAY_CreateVector(VARTYPE vt
, LONG lLbound
, ULONG cElements
, ULONG ulSize
)
247 SAFEARRAY
*psa
= NULL
;
249 if (ulSize
|| (vt
== VT_RECORD
))
251 /* Allocate the header and data together */
252 if (SUCCEEDED(SAFEARRAY_AllocDescriptor(sizeof(SAFEARRAY
) + ulSize
* cElements
, &psa
)))
254 SAFEARRAY_SetFeatures(vt
, psa
);
257 psa
->fFeatures
|= FADF_CREATEVECTOR
;
258 psa
->pvData
= &psa
[1]; /* Data follows the header */
259 psa
->cbElements
= ulSize
;
260 psa
->rgsabound
[0].cElements
= cElements
;
261 psa
->rgsabound
[0].lLbound
= lLbound
;
265 case VT_BSTR
: psa
->fFeatures
|= FADF_BSTR
; break;
266 case VT_UNKNOWN
: psa
->fFeatures
|= FADF_UNKNOWN
; break;
267 case VT_DISPATCH
: psa
->fFeatures
|= FADF_DISPATCH
; break;
268 case VT_VARIANT
: psa
->fFeatures
|= FADF_VARIANT
; break;
275 /* Free data items in an array */
276 static HRESULT
SAFEARRAY_DestroyData(SAFEARRAY
*psa
, ULONG ulStartCell
)
278 if (psa
->pvData
&& !(psa
->fFeatures
& FADF_DATADELETED
))
280 ULONG ulCellCount
= SAFEARRAY_GetCellCount(psa
);
282 if (ulStartCell
> ulCellCount
) {
283 FIXME("unexpted ulcellcount %d, start %d\n",ulCellCount
,ulStartCell
);
287 ulCellCount
-= ulStartCell
;
289 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
291 LPUNKNOWN
*lpUnknown
= (LPUNKNOWN
*)psa
->pvData
+ ulStartCell
;
296 IUnknown_Release(*lpUnknown
);
300 else if (psa
->fFeatures
& (FADF_RECORD
))
302 IRecordInfo
*lpRecInfo
;
304 if (SUCCEEDED(SafeArrayGetRecordInfo(psa
, &lpRecInfo
)))
306 PBYTE pRecordData
= psa
->pvData
;
309 IRecordInfo_RecordClear(lpRecInfo
, pRecordData
);
310 pRecordData
+= psa
->cbElements
;
312 IRecordInfo_Release(lpRecInfo
);
315 else if (psa
->fFeatures
& FADF_BSTR
)
317 BSTR
* lpBstr
= (BSTR
*)psa
->pvData
+ ulStartCell
;
321 SysFreeString(*lpBstr
);
325 else if (psa
->fFeatures
& FADF_VARIANT
)
327 VARIANT
* lpVariant
= (VARIANT
*)psa
->pvData
+ ulStartCell
;
331 HRESULT hRet
= VariantClear(lpVariant
);
333 if (FAILED(hRet
)) FIXME("VariantClear of element failed!\n");
341 /* Copy data items from one array to another */
342 static HRESULT
SAFEARRAY_CopyData(SAFEARRAY
*psa
, SAFEARRAY
*dest
)
346 else if (!dest
->pvData
|| psa
->fFeatures
& FADF_DATADELETED
)
350 ULONG ulCellCount
= SAFEARRAY_GetCellCount(psa
);
352 dest
->fFeatures
= (dest
->fFeatures
& FADF_CREATEVECTOR
) |
353 (psa
->fFeatures
& ~(FADF_CREATEVECTOR
|FADF_DATADELETED
));
355 if (psa
->fFeatures
& FADF_VARIANT
)
357 VARIANT
* lpVariant
= psa
->pvData
;
358 VARIANT
* lpDest
= dest
->pvData
;
364 hRet
= VariantCopy(lpDest
, lpVariant
);
365 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%x\n", hRet
);
370 else if (psa
->fFeatures
& FADF_BSTR
)
372 BSTR
* lpBstr
= psa
->pvData
;
373 BSTR
* lpDest
= dest
->pvData
;
379 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
381 return E_OUTOFMEMORY
;
391 /* Copy the data over */
392 memcpy(dest
->pvData
, psa
->pvData
, ulCellCount
* psa
->cbElements
);
394 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
396 LPUNKNOWN
*lpUnknown
= dest
->pvData
;
401 IUnknown_AddRef(*lpUnknown
);
407 if (psa
->fFeatures
& FADF_RECORD
)
409 IRecordInfo
* pRecInfo
= NULL
;
411 SafeArrayGetRecordInfo(psa
, &pRecInfo
);
412 SafeArraySetRecordInfo(dest
, pRecInfo
);
416 /* Release because Get() adds a reference */
417 IRecordInfo_Release(pRecInfo
);
420 else if (psa
->fFeatures
& FADF_HAVEIID
)
423 SafeArrayGetIID(psa
, &guid
);
424 SafeArraySetIID(dest
, &guid
);
426 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
428 SAFEARRAY_SetHiddenDWORD(dest
, SAFEARRAY_GetHiddenDWORD(psa
));
434 /*************************************************************************
435 * SafeArrayAllocDescriptor (OLEAUT32.36)
437 * Allocate and initialise a descriptor for a SafeArray.
440 * cDims [I] Number of dimensions of the array
441 * ppsaOut [O] Destination for new descriptor
444 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
445 * Failure: An HRESULT error code indicating the error.
450 HRESULT WINAPI
SafeArrayAllocDescriptor(UINT cDims
, SAFEARRAY
**ppsaOut
)
454 TRACE("(%d,%p)\n", cDims
, ppsaOut
);
456 if (!cDims
|| cDims
>= 0x10000) /* Maximum 65535 dimensions */
462 /* We need enough space for the header and its bounds */
463 allocSize
= sizeof(SAFEARRAY
) + sizeof(SAFEARRAYBOUND
) * (cDims
- 1);
465 if (FAILED(SAFEARRAY_AllocDescriptor(allocSize
, ppsaOut
)))
468 (*ppsaOut
)->cDims
= cDims
;
470 TRACE("(%d): %u bytes allocated for descriptor.\n", cDims
, allocSize
);
474 /*************************************************************************
475 * SafeArrayAllocDescriptorEx (OLEAUT32.41)
477 * Allocate and initialise a descriptor for a SafeArray of a given type.
480 * vt [I] The type of items to store in the array
481 * cDims [I] Number of dimensions of the array
482 * ppsaOut [O] Destination for new descriptor
485 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
486 * Failure: An HRESULT error code indicating the error.
489 * - This function does not check that vt is an allowed VARTYPE.
490 * - Unlike SafeArrayAllocDescriptor(), vt is associated with the array.
493 HRESULT WINAPI
SafeArrayAllocDescriptorEx(VARTYPE vt
, UINT cDims
, SAFEARRAY
**ppsaOut
)
496 HRESULT hRet
= E_UNEXPECTED
;
498 TRACE("(%d->%s,%d,%p)\n", vt
, debugstr_vt(vt
), cDims
, ppsaOut
);
500 cbElements
= SAFEARRAY_GetVTSize(vt
);
502 WARN("Creating a descriptor with an invalid VARTYPE!\n");
504 hRet
= SafeArrayAllocDescriptor(cDims
, ppsaOut
);
508 SAFEARRAY_SetFeatures(vt
, *ppsaOut
);
509 (*ppsaOut
)->cbElements
= cbElements
;
514 /*************************************************************************
515 * SafeArrayAllocData (OLEAUT32.37)
517 * Allocate the data area of a SafeArray.
520 * psa [I] SafeArray to allocate the data area of.
523 * Success: S_OK. The data area is allocated and initialised.
524 * Failure: An HRESULT error code indicating the error.
529 HRESULT WINAPI
SafeArrayAllocData(SAFEARRAY
*psa
)
531 HRESULT hRet
= E_INVALIDARG
;
533 TRACE("(%p)\n", psa
);
537 ULONG ulSize
= SAFEARRAY_GetCellCount(psa
);
539 psa
->pvData
= SAFEARRAY_Malloc(ulSize
* psa
->cbElements
);
544 TRACE("%u bytes allocated for data at %p (%u objects).\n",
545 ulSize
* psa
->cbElements
, psa
->pvData
, ulSize
);
548 hRet
= E_OUTOFMEMORY
;
553 /*************************************************************************
554 * SafeArrayCreate (OLEAUT32.15)
556 * Create a new SafeArray.
559 * vt [I] Type to store in the safe array
560 * cDims [I] Number of array dimensions
561 * rgsabound [I] Bounds of the array dimensions
564 * Success: A pointer to a new array object.
565 * Failure: NULL, if any parameter is invalid or memory allocation fails.
568 * Win32 allows arrays with 0 sized dimensions. This bug is not reproduced
569 * in the Wine implementation.
572 SAFEARRAY
* WINAPI
SafeArrayCreate(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
)
574 TRACE("(%d->%s,%d,%p)\n", vt
, debugstr_vt(vt
), cDims
, rgsabound
);
579 return SAFEARRAY_Create(vt
, cDims
, rgsabound
, 0);
582 /*************************************************************************
583 * SafeArrayCreateEx (OLEAUT32.15)
585 * Create a new SafeArray.
588 * vt [I] Type to store in the safe array
589 * cDims [I] Number of array dimensions
590 * rgsabound [I] Bounds of the array dimensions
591 * pvExtra [I] Extra data
594 * Success: A pointer to a new array object.
595 * Failure: NULL, if any parameter is invalid or memory allocation fails.
600 SAFEARRAY
* WINAPI
SafeArrayCreateEx(VARTYPE vt
, UINT cDims
, SAFEARRAYBOUND
*rgsabound
, LPVOID pvExtra
)
603 IRecordInfo
* iRecInfo
= pvExtra
;
606 TRACE("(%d->%s,%d,%p,%p)\n", vt
, debugstr_vt(vt
), cDims
, rgsabound
, pvExtra
);
612 IRecordInfo_GetSize(iRecInfo
, &ulSize
);
614 psa
= SAFEARRAY_Create(vt
, cDims
, rgsabound
, ulSize
);
621 SafeArraySetRecordInfo(psa
, pvExtra
);
625 SafeArraySetIID(psa
, pvExtra
);
632 /************************************************************************
633 * SafeArrayCreateVector (OLEAUT32.411)
635 * Create a one dimensional, contiguous SafeArray.
638 * vt [I] Type to store in the safe array
639 * lLbound [I] Lower bound of the array
640 * cElements [I] Number of elements in the array
643 * Success: A pointer to a new array object.
644 * Failure: NULL, if any parameter is invalid or memory allocation fails.
649 SAFEARRAY
* WINAPI
SafeArrayCreateVector(VARTYPE vt
, LONG lLbound
, ULONG cElements
)
651 TRACE("(%d->%s,%d,%d\n", vt
, debugstr_vt(vt
), lLbound
, cElements
);
656 return SAFEARRAY_CreateVector(vt
, lLbound
, cElements
, SAFEARRAY_GetVTSize(vt
));
659 /************************************************************************
660 * SafeArrayCreateVectorEx (OLEAUT32.411)
662 * Create a one dimensional, contiguous SafeArray.
665 * vt [I] Type to store in the safe array
666 * lLbound [I] Lower bound of the array
667 * cElements [I] Number of elements in the array
668 * pvExtra [I] Extra data
671 * Success: A pointer to a new array object.
672 * Failure: NULL, if any parameter is invalid or memory allocation fails.
677 SAFEARRAY
* WINAPI
SafeArrayCreateVectorEx(VARTYPE vt
, LONG lLbound
, ULONG cElements
, LPVOID pvExtra
)
680 IRecordInfo
* iRecInfo
= pvExtra
;
683 TRACE("(%d->%s,%d,%d,%p\n", vt
, debugstr_vt(vt
), lLbound
, cElements
, pvExtra
);
689 IRecordInfo_GetSize(iRecInfo
, &ulSize
);
692 ulSize
= SAFEARRAY_GetVTSize(vt
);
694 psa
= SAFEARRAY_CreateVector(vt
, lLbound
, cElements
, ulSize
);
701 SafeArraySetRecordInfo(psa
, iRecInfo
);
705 SafeArraySetIID(psa
, pvExtra
);
712 /*************************************************************************
713 * SafeArrayDestroyDescriptor (OLEAUT32.38)
715 * Destroy a SafeArray.
718 * psa [I] SafeArray to destroy.
721 * Success: S_OK. The resources used by the array are freed.
722 * Failure: An HRESULT error code indicating the error.
727 HRESULT WINAPI
SafeArrayDestroyDescriptor(SAFEARRAY
*psa
)
729 TRACE("(%p)\n", psa
);
733 LPVOID lpv
= (char*)psa
- SAFEARRAY_HIDDEN_SIZE
;
736 return DISP_E_ARRAYISLOCKED
; /* Can't destroy a locked array */
738 if (psa
->fFeatures
& FADF_RECORD
)
739 SafeArraySetRecordInfo(psa
, NULL
);
741 if (psa
->fFeatures
& FADF_CREATEVECTOR
&&
742 !(psa
->fFeatures
& FADF_DATADELETED
))
743 SAFEARRAY_DestroyData(psa
, 0); /* Data not previously deleted */
745 if (!SAFEARRAY_Free(lpv
))
751 /*************************************************************************
752 * SafeArrayLock (OLEAUT32.21)
754 * Increment the lock counter of a SafeArray.
757 * psa [O] SafeArray to lock
760 * Success: S_OK. The array lock is incremented.
761 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if too many locks
762 * are held on the array at once.
765 * In Win32 these locks are not thread safe.
768 HRESULT WINAPI
SafeArrayLock(SAFEARRAY
*psa
)
772 TRACE("(%p)\n", psa
);
777 ulLocks
= InterlockedIncrement( (LONG
*) &psa
->cLocks
);
779 if (ulLocks
> 0xffff) /* Maximum of 16384 locks at a time */
781 WARN("Out of locks!\n");
782 InterlockedDecrement( (LONG
*) &psa
->cLocks
);
788 /*************************************************************************
789 * SafeArrayUnlock (OLEAUT32.22)
791 * Decrement the lock counter of a SafeArray.
794 * psa [O] SafeArray to unlock
797 * Success: S_OK. The array lock is decremented.
798 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if no locks are
804 HRESULT WINAPI
SafeArrayUnlock(SAFEARRAY
*psa
)
806 TRACE("(%p)\n", psa
);
811 if (InterlockedDecrement( (LONG
*) &psa
->cLocks
) < 0)
813 WARN("Unlocked but no lock held!\n");
814 InterlockedIncrement( (LONG
*) &psa
->cLocks
);
820 /*************************************************************************
821 * SafeArrayPutElement (OLEAUT32.26)
823 * Put an item into a SafeArray.
826 * psa [I] SafeArray to insert into
827 * rgIndices [I] Indices to insert at
828 * pvData [I] Data to insert
831 * Success: S_OK. The item is inserted
832 * Failure: An HRESULT error code indicating the error.
837 HRESULT WINAPI
SafeArrayPutElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
841 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
843 if (!psa
|| !rgIndices
)
846 hRet
= SafeArrayLock(psa
);
852 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvDest
);
856 if (psa
->fFeatures
& FADF_VARIANT
)
858 VARIANT
* lpVariant
= pvData
;
859 VARIANT
* lpDest
= lpvDest
;
861 hRet
= VariantClear(lpDest
);
862 if (FAILED(hRet
)) FIXME("VariantClear failed with 0x%x\n", hRet
);
863 hRet
= VariantCopy(lpDest
, lpVariant
);
864 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%x\n", hRet
);
866 else if (psa
->fFeatures
& FADF_BSTR
)
868 BSTR lpBstr
= (BSTR
)pvData
;
869 BSTR
* lpDest
= lpvDest
;
871 SysFreeString(*lpDest
);
873 *lpDest
= SysAllocStringByteLen((char*)lpBstr
, SysStringByteLen(lpBstr
));
875 hRet
= E_OUTOFMEMORY
;
879 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
881 LPUNKNOWN lpUnknown
= pvData
;
882 LPUNKNOWN
*lpDest
= lpvDest
;
885 IUnknown_AddRef(lpUnknown
);
887 IUnknown_Release(*lpDest
);
890 /* Copy the data over */
891 memcpy(lpvDest
, pvData
, psa
->cbElements
);
895 SafeArrayUnlock(psa
);
901 /*************************************************************************
902 * SafeArrayGetElement (OLEAUT32.25)
904 * Get an item from a SafeArray.
907 * psa [I] SafeArray to get from
908 * rgIndices [I] Indices to get from
909 * pvData [O] Destination for data
912 * Success: S_OK. The item data is returned in pvData.
913 * Failure: An HRESULT error code indicating the error.
918 HRESULT WINAPI
SafeArrayGetElement(SAFEARRAY
*psa
, LONG
*rgIndices
, void *pvData
)
922 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, pvData
);
924 if (!psa
|| !rgIndices
|| !pvData
)
927 hRet
= SafeArrayLock(psa
);
933 hRet
= SafeArrayPtrOfIndex(psa
, rgIndices
, &lpvSrc
);
937 if (psa
->fFeatures
& FADF_VARIANT
)
939 VARIANT
* lpVariant
= lpvSrc
;
940 VARIANT
* lpDest
= pvData
;
942 /* The original content of pvData is ignored. */
943 V_VT(lpDest
) = VT_EMPTY
;
944 hRet
= VariantCopy(lpDest
, lpVariant
);
945 if (FAILED(hRet
)) FIXME("VariantCopy failed with 0x%x\n", hRet
);
947 else if (psa
->fFeatures
& FADF_BSTR
)
949 BSTR
* lpBstr
= lpvSrc
;
950 BSTR
* lpDest
= pvData
;
954 *lpDest
= SysAllocStringByteLen((char*)*lpBstr
, SysStringByteLen(*lpBstr
));
956 hRet
= E_OUTOFMEMORY
;
963 if (psa
->fFeatures
& (FADF_UNKNOWN
|FADF_DISPATCH
))
965 LPUNKNOWN
*lpUnknown
= lpvSrc
;
968 IUnknown_AddRef(*lpUnknown
);
970 /* Copy the data over */
971 memcpy(pvData
, lpvSrc
, psa
->cbElements
);
974 SafeArrayUnlock(psa
);
979 /*************************************************************************
980 * SafeArrayGetUBound (OLEAUT32.19)
982 * Get the upper bound for a given SafeArray dimension
985 * psa [I] Array to get dimension upper bound from
986 * nDim [I] The dimension number to get the upper bound of
987 * plUbound [O] Destination for the upper bound
990 * Success: S_OK. plUbound contains the dimensions upper bound.
991 * Failure: An HRESULT error code indicating the error.
996 HRESULT WINAPI
SafeArrayGetUBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plUbound
)
998 TRACE("(%p,%d,%p)\n", psa
, nDim
, plUbound
);
1000 if (!psa
|| !plUbound
)
1001 return E_INVALIDARG
;
1003 if(!nDim
|| nDim
> psa
->cDims
)
1004 return DISP_E_BADINDEX
;
1006 *plUbound
= psa
->rgsabound
[psa
->cDims
- nDim
].lLbound
+
1007 psa
->rgsabound
[psa
->cDims
- nDim
].cElements
- 1;
1012 /*************************************************************************
1013 * SafeArrayGetLBound (OLEAUT32.20)
1015 * Get the lower bound for a given SafeArray dimension
1018 * psa [I] Array to get dimension lower bound from
1019 * nDim [I] The dimension number to get the lowe bound of
1020 * plLbound [O] Destination for the lower bound
1023 * Success: S_OK. plUbound contains the dimensions lower bound.
1024 * Failure: An HRESULT error code indicating the error.
1029 HRESULT WINAPI
SafeArrayGetLBound(SAFEARRAY
*psa
, UINT nDim
, LONG
*plLbound
)
1031 TRACE("(%p,%d,%p)\n", psa
, nDim
, plLbound
);
1033 if (!psa
|| !plLbound
)
1034 return E_INVALIDARG
;
1036 if(!nDim
|| nDim
> psa
->cDims
)
1037 return DISP_E_BADINDEX
;
1039 *plLbound
= psa
->rgsabound
[psa
->cDims
- nDim
].lLbound
;
1043 /*************************************************************************
1044 * SafeArrayGetDim (OLEAUT32.17)
1046 * Get the number of dimensions in a SafeArray.
1049 * psa [I] Array to get the dimensions of
1052 * The number of array dimensions in psa, or 0 if psa is NULL.
1057 UINT WINAPI
SafeArrayGetDim(SAFEARRAY
*psa
)
1059 TRACE("(%p) returning %d\n", psa
, psa
? psa
->cDims
: 0u);
1060 return psa
? psa
->cDims
: 0;
1063 /*************************************************************************
1064 * SafeArrayGetElemsize (OLEAUT32.18)
1066 * Get the size of an element in a SafeArray.
1069 * psa [I] Array to get the element size from
1072 * The size of a single element in psa, or 0 if psa is NULL.
1077 UINT WINAPI
SafeArrayGetElemsize(SAFEARRAY
*psa
)
1079 TRACE("(%p) returning %d\n", psa
, psa
? psa
->cbElements
: 0u);
1080 return psa
? psa
->cbElements
: 0;
1083 /*************************************************************************
1084 * SafeArrayAccessData (OLEAUT32.23)
1086 * Lock a SafeArray and return a pointer to its data.
1089 * psa [I] Array to get the data pointer from
1090 * ppvData [O] Destination for the arrays data pointer
1093 * Success: S_OK. ppvData contains the arrays data pointer, and the array
1095 * Failure: An HRESULT error code indicating the error.
1100 HRESULT WINAPI
SafeArrayAccessData(SAFEARRAY
*psa
, void **ppvData
)
1102 TRACE("(%p,%p)\n", psa
, ppvData
);
1104 if(!psa
|| !ppvData
)
1105 return E_INVALIDARG
;
1107 if (SUCCEEDED(SafeArrayLock(psa
)))
1109 *ppvData
= psa
->pvData
;
1113 return E_UNEXPECTED
;
1117 /*************************************************************************
1118 * SafeArrayUnaccessData (OLEAUT32.24)
1120 * Unlock a SafeArray after accessing its data.
1123 * psa [I] Array to unlock
1126 * Success: S_OK. The array is unlocked.
1127 * Failure: An HRESULT error code indicating the error.
1132 HRESULT WINAPI
SafeArrayUnaccessData(SAFEARRAY
*psa
)
1134 TRACE("(%p)\n", psa
);
1135 return SafeArrayUnlock(psa
);
1138 /************************************************************************
1139 * SafeArrayPtrOfIndex (OLEAUT32.148)
1141 * Get the address of an item in a SafeArray.
1144 * psa [I] Array to get the items address from
1145 * rgIndices [I] Index of the item in the array
1146 * ppvData [O] Destination for item address
1149 * Success: S_OK. ppvData contains a pointer to the item.
1150 * Failure: An HRESULT error code indicating the error.
1153 * This function does not lock the array.
1158 HRESULT WINAPI
SafeArrayPtrOfIndex(SAFEARRAY
*psa
, LONG
*rgIndices
, void **ppvData
)
1161 ULONG cell
= 0, dimensionSize
= 1;
1162 SAFEARRAYBOUND
* psab
;
1165 TRACE("(%p,%p,%p)\n", psa
, rgIndices
, ppvData
);
1167 /* The general formula for locating the cell number of an entry in an n
1168 * dimensional array (where cn = coordinate in dimension dn) is:
1170 * c1 + c2 * sizeof(d1) + c3 * sizeof(d2) ... + cn * sizeof(c(n-1))
1172 * We calculate the size of the last dimension at each step through the
1173 * dimensions to avoid recursing to calculate the last dimensions size.
1175 if (!psa
|| !rgIndices
|| !ppvData
)
1176 return E_INVALIDARG
;
1178 psab
= psa
->rgsabound
+ psa
->cDims
- 1;
1181 if (c1
< psab
->lLbound
|| c1
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1182 return DISP_E_BADINDEX
; /* Initial index out of bounds */
1184 for (dim
= 1; dim
< psa
->cDims
; dim
++)
1186 dimensionSize
*= psab
->cElements
;
1190 if (!psab
->cElements
||
1191 *rgIndices
< psab
->lLbound
||
1192 *rgIndices
>= psab
->lLbound
+ (LONG
)psab
->cElements
)
1193 return DISP_E_BADINDEX
; /* Index out of bounds */
1195 cell
+= (*rgIndices
- psab
->lLbound
) * dimensionSize
;
1199 cell
+= (c1
- psa
->rgsabound
[psa
->cDims
- 1].lLbound
);
1201 *ppvData
= (char*)psa
->pvData
+ cell
* psa
->cbElements
;
1205 /************************************************************************
1206 * SafeArrayDestroyData (OLEAUT32.39)
1208 * Destroy the data associated with a SafeArray.
1211 * psa [I] Array to delete the data from
1214 * Success: S_OK. All items and the item data are freed.
1215 * Failure: An HRESULT error code indicating the error.
1220 HRESULT WINAPI
SafeArrayDestroyData(SAFEARRAY
*psa
)
1222 TRACE("(%p)\n", psa
);
1225 return E_INVALIDARG
;
1228 return DISP_E_ARRAYISLOCKED
; /* Can't delete a locked array */
1230 /* Delete the actual item data */
1231 if (FAILED(SAFEARRAY_DestroyData(psa
, 0)))
1232 return E_UNEXPECTED
;
1236 if (psa
->fFeatures
& FADF_STATIC
)
1238 ZeroMemory(psa
->pvData
, SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
);
1241 /* If this is not a vector, free the data memory block */
1242 if (!(psa
->fFeatures
& FADF_CREATEVECTOR
))
1244 if (!SAFEARRAY_Free(psa
->pvData
))
1245 return E_UNEXPECTED
;
1249 psa
->fFeatures
|= FADF_DATADELETED
; /* Mark the data deleted */
1255 /************************************************************************
1256 * SafeArrayCopyData (OLEAUT32.412)
1258 * Copy all data from one SafeArray to another.
1261 * psaSource [I] Source for copy
1262 * psaTarget [O] Destination for copy
1265 * Success: S_OK. psaTarget contains a copy of psaSource.
1266 * Failure: An HRESULT error code indicating the error.
1269 * The two arrays must have the same number of dimensions and elements.
1274 HRESULT WINAPI
SafeArrayCopyData(SAFEARRAY
*psaSource
, SAFEARRAY
*psaTarget
)
1278 TRACE("(%p,%p)\n", psaSource
, psaTarget
);
1280 if (!psaSource
|| !psaTarget
||
1281 psaSource
->cDims
!= psaTarget
->cDims
||
1282 psaSource
->cbElements
!= psaTarget
->cbElements
)
1283 return E_INVALIDARG
;
1285 /* Each dimension must be the same size */
1286 for (dim
= psaSource
->cDims
- 1; dim
>= 0 ; dim
--)
1287 if (psaSource
->rgsabound
[dim
].cElements
!=
1288 psaTarget
->rgsabound
[dim
].cElements
)
1289 return E_INVALIDARG
;
1291 if (SUCCEEDED(SAFEARRAY_DestroyData(psaTarget
, 0)) &&
1292 SUCCEEDED(SAFEARRAY_CopyData(psaSource
, psaTarget
)))
1294 return E_UNEXPECTED
;
1297 /************************************************************************
1298 * SafeArrayDestroy (OLEAUT32.16)
1300 * Destroy a SafeArray.
1303 * psa [I] Array to destroy
1306 * Success: S_OK. All resources used by the array are freed.
1307 * Failure: An HRESULT error code indicating the error.
1312 HRESULT WINAPI
SafeArrayDestroy(SAFEARRAY
*psa
)
1314 TRACE("(%p)\n", psa
);
1320 return DISP_E_ARRAYISLOCKED
;
1322 /* Native doesn't check to see if the free succeeds */
1323 SafeArrayDestroyData(psa
);
1324 SafeArrayDestroyDescriptor(psa
);
1328 /************************************************************************
1329 * SafeArrayCopy (OLEAUT32.27)
1331 * Make a duplicate of a SafeArray.
1334 * psa [I] Source for copy
1335 * ppsaOut [O] Destination for new copy
1338 * Success: S_OK. ppsaOut contains a copy of the array.
1339 * Failure: An HRESULT error code indicating the error.
1344 HRESULT WINAPI
SafeArrayCopy(SAFEARRAY
*psa
, SAFEARRAY
**ppsaOut
)
1348 TRACE("(%p,%p)\n", psa
, ppsaOut
);
1351 return E_INVALIDARG
;
1356 return S_OK
; /* Handles copying of NULL arrays */
1358 if (!psa
->cbElements
)
1359 return E_INVALIDARG
;
1361 if (psa
->fFeatures
& (FADF_RECORD
|FADF_HAVEIID
|FADF_HAVEVARTYPE
))
1364 if (FAILED(SafeArrayGetVartype(psa
, &vt
)))
1365 hRet
= E_UNEXPECTED
;
1367 hRet
= SafeArrayAllocDescriptorEx(vt
, psa
->cDims
, ppsaOut
);
1371 hRet
= SafeArrayAllocDescriptor(psa
->cDims
, ppsaOut
);
1372 if (SUCCEEDED(hRet
))
1374 (*ppsaOut
)->fFeatures
= psa
->fFeatures
& ~FADF_CREATEVECTOR
;
1375 (*ppsaOut
)->cbElements
= psa
->cbElements
;
1379 if (SUCCEEDED(hRet
))
1381 /* Copy dimension bounds */
1382 memcpy((*ppsaOut
)->rgsabound
, psa
->rgsabound
, psa
->cDims
* sizeof(SAFEARRAYBOUND
));
1384 (*ppsaOut
)->pvData
= SAFEARRAY_Malloc(SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
);
1386 if ((*ppsaOut
)->pvData
)
1388 hRet
= SAFEARRAY_CopyData(psa
, *ppsaOut
);
1390 if (SUCCEEDED(hRet
))
1393 SAFEARRAY_Free((*ppsaOut
)->pvData
);
1395 SafeArrayDestroyDescriptor(*ppsaOut
);
1401 /************************************************************************
1402 * SafeArrayRedim (OLEAUT32.40)
1404 * Changes the characteristics of the last dimension of a SafeArray
1407 * psa [I] Array to change
1408 * psabound [I] New bound details for the last dimension
1411 * Success: S_OK. psa is updated to reflect the new bounds.
1412 * Failure: An HRESULT error code indicating the error.
1417 HRESULT WINAPI
SafeArrayRedim(SAFEARRAY
*psa
, SAFEARRAYBOUND
*psabound
)
1419 SAFEARRAYBOUND
*oldBounds
;
1421 TRACE("(%p,%p)\n", psa
, psabound
);
1423 if (!psa
|| psa
->fFeatures
& FADF_FIXEDSIZE
|| !psabound
)
1424 return E_INVALIDARG
;
1426 if (psa
->cLocks
> 0)
1427 return DISP_E_ARRAYISLOCKED
;
1429 if (FAILED(SafeArrayLock(psa
)))
1430 return E_UNEXPECTED
;
1432 oldBounds
= psa
->rgsabound
;
1433 oldBounds
->lLbound
= psabound
->lLbound
;
1435 if (psabound
->cElements
!= oldBounds
->cElements
)
1437 if (psabound
->cElements
< oldBounds
->cElements
)
1439 /* Shorten the final dimension. */
1440 ULONG ulStartCell
= psabound
->cElements
*
1441 (SAFEARRAY_GetCellCount(psa
) / oldBounds
->cElements
);
1442 SAFEARRAY_DestroyData(psa
, ulStartCell
);
1446 /* Lengthen the final dimension */
1447 ULONG ulOldSize
, ulNewSize
;
1450 ulOldSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1452 ulNewSize
= (ulOldSize
/ oldBounds
->cElements
) * psabound
->cElements
;
1454 int oldelems
= oldBounds
->cElements
;
1455 oldBounds
->cElements
= psabound
->cElements
;
1456 ulNewSize
= SAFEARRAY_GetCellCount(psa
) * psa
->cbElements
;
1457 oldBounds
->cElements
= oldelems
;
1460 if (!(pvNewData
= SAFEARRAY_Malloc(ulNewSize
)))
1462 SafeArrayUnlock(psa
);
1463 return E_UNEXPECTED
;
1466 memcpy(pvNewData
, psa
->pvData
, ulOldSize
);
1467 SAFEARRAY_Free(psa
->pvData
);
1468 psa
->pvData
= pvNewData
;
1470 oldBounds
->cElements
= psabound
->cElements
;
1473 SafeArrayUnlock(psa
);
1477 /************************************************************************
1478 * SafeArrayGetVartype (OLEAUT32.77)
1480 * Get the type of the items in a SafeArray.
1483 * psa [I] Array to get the type from
1484 * pvt [O] Destination for the type
1487 * Success: S_OK. pvt contains the type of the items.
1488 * Failure: An HRESULT error code indicating the error.
1493 HRESULT WINAPI
SafeArrayGetVartype(SAFEARRAY
* psa
, VARTYPE
* pvt
)
1495 TRACE("(%p,%p)\n", psa
, pvt
);
1498 return E_INVALIDARG
;
1500 if (psa
->fFeatures
& FADF_RECORD
)
1502 else if ((psa
->fFeatures
& (FADF_HAVEIID
|FADF_DISPATCH
)) == (FADF_HAVEIID
|FADF_DISPATCH
))
1504 else if (psa
->fFeatures
& FADF_HAVEIID
)
1506 else if (psa
->fFeatures
& FADF_HAVEVARTYPE
)
1508 VARTYPE vt
= SAFEARRAY_GetHiddenDWORD(psa
);
1512 return E_INVALIDARG
;
1517 /************************************************************************
1518 * SafeArraySetRecordInfo (OLEAUT32.@)
1520 * Set the record info for a SafeArray.
1523 * psa [I] Array to set the record info for
1524 * pRinfo [I] Record info
1527 * Success: S_OK. The record info is stored with the array.
1528 * Failure: An HRESULT error code indicating the error.
1533 HRESULT WINAPI
SafeArraySetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
*pRinfo
)
1535 IRecordInfo
** dest
= (IRecordInfo
**)psa
;
1537 TRACE("(%p,%p)\n", psa
, pRinfo
);
1539 if (!psa
|| !(psa
->fFeatures
& FADF_RECORD
))
1540 return E_INVALIDARG
;
1543 IRecordInfo_AddRef(pRinfo
);
1546 IRecordInfo_Release(dest
[-1]);
1552 /************************************************************************
1553 * SafeArrayGetRecordInfo (OLEAUT32.@)
1555 * Get the record info from a SafeArray.
1558 * psa [I] Array to get the record info from
1559 * pRinfo [O] Destination for the record info
1562 * Success: S_OK. pRinfo contains the record info, or NULL if there was none.
1563 * Failure: An HRESULT error code indicating the error.
1568 HRESULT WINAPI
SafeArrayGetRecordInfo(SAFEARRAY
*psa
, IRecordInfo
**pRinfo
)
1570 IRecordInfo
** src
= (IRecordInfo
**)psa
;
1572 TRACE("(%p,%p)\n", psa
, pRinfo
);
1574 if (!psa
|| !pRinfo
|| !(psa
->fFeatures
& FADF_RECORD
))
1575 return E_INVALIDARG
;
1580 IRecordInfo_AddRef(*pRinfo
);
1584 /************************************************************************
1585 * SafeArraySetIID (OLEAUT32.@)
1587 * Set the IID for a SafeArray.
1590 * psa [I] Array to set the IID from
1594 * Success: S_OK. The IID is stored with the array
1595 * Failure: An HRESULT error code indicating the error.
1600 HRESULT WINAPI
SafeArraySetIID(SAFEARRAY
*psa
, REFGUID guid
)
1602 GUID
* dest
= (GUID
*)psa
;
1604 TRACE("(%p,%s)\n", psa
, debugstr_guid(guid
));
1606 if (!psa
|| !guid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1607 return E_INVALIDARG
;
1613 /************************************************************************
1614 * SafeArrayGetIID (OLEAUT32.@)
1616 * Get the IID from a SafeArray.
1619 * psa [I] Array to get the ID from
1620 * pGuid [O] Destination for the IID
1623 * Success: S_OK. pRinfo contains the IID, or NULL if there was none.
1624 * Failure: An HRESULT error code indicating the error.
1629 HRESULT WINAPI
SafeArrayGetIID(SAFEARRAY
*psa
, GUID
*pGuid
)
1631 GUID
* src
= (GUID
*)psa
;
1633 TRACE("(%p,%p)\n", psa
, pGuid
);
1635 if (!psa
|| !pGuid
|| !(psa
->fFeatures
& FADF_HAVEIID
))
1636 return E_INVALIDARG
;
1642 /************************************************************************
1643 * VectorFromBstr (OLEAUT32.@)
1645 * Create a SafeArray Vector from the bytes of a BSTR.
1648 * bstr [I] String to get bytes from
1649 * ppsa [O] Destination for the array
1652 * Success: S_OK. ppsa contains the strings bytes as a VT_UI1 array.
1653 * Failure: An HRESULT error code indicating the error.
1658 HRESULT WINAPI
VectorFromBstr(BSTR bstr
, SAFEARRAY
**ppsa
)
1662 TRACE("(%p,%p)\n", bstr
, ppsa
);
1665 return E_INVALIDARG
;
1668 sab
.cElements
= SysStringByteLen(bstr
);
1670 *ppsa
= SAFEARRAY_Create(VT_UI1
, 1, &sab
, 0);
1674 memcpy((*ppsa
)->pvData
, bstr
, sab
.cElements
);
1677 return E_OUTOFMEMORY
;
1680 /************************************************************************
1681 * BstrFromVector (OLEAUT32.@)
1683 * Create a BSTR from a SafeArray.
1686 * psa [I] Source array
1687 * pbstr [O] Destination for output BSTR
1690 * Success: S_OK. pbstr contains the arrays data.
1691 * Failure: An HRESULT error code indicating the error.
1694 * psa must be a 1 dimensional array of a 1 byte type.
1699 HRESULT WINAPI
BstrFromVector(SAFEARRAY
*psa
, BSTR
*pbstr
)
1701 TRACE("(%p,%p)\n", psa
, pbstr
);
1704 return E_INVALIDARG
;
1708 if (!psa
|| psa
->cbElements
!= 1 || psa
->cDims
!= 1)
1709 return E_INVALIDARG
;
1711 *pbstr
= SysAllocStringByteLen(psa
->pvData
, psa
->rgsabound
[0].cElements
);
1713 return E_OUTOFMEMORY
;