msxml3: SysAllocString*() automatically allocates a terminating NULL.
[wine/multimedia.git] / dlls / oleaut32 / safearray.c
blobced885ca751d59b3f031d6036d5b42687fce7bb2
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))
30 * 0x00: SAFEARRAY,
31 * 0x10: SAFEARRAYBOUNDS[0...]
34 #include "config.h"
36 #include <string.h>
37 #include <stdarg.h>
38 #include <stdio.h>
40 #define COBJMACROS
42 #include "windef.h"
43 #include "winerror.h"
44 #include "winbase.h"
45 #include "variant.h"
46 #include "wine/debug.h"
48 WINE_DEFAULT_DEBUG_CHANNEL(variant);
50 /************************************************************************
51 * SafeArray {OLEAUT32}
53 * NOTES
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
68 * single dimension.
70 * DATATYPES
71 * The following types of data can be stored within a SafeArray.
72 * Numeric:
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
75 * Interfaces:
76 *| VT_DISPATCH, VT_UNKNOWN, VT_RECORD
77 * Other:
78 *| VT_VARIANT, VT_INT_PTR, VT_UINT_PTR, VT_BOOL, VT_ERROR, VT_DATE, VT_BSTR
80 * FUNCTIONS
81 * BstrFromVector()
82 * VectorFromBstr()
85 /* Undocumented hidden space before the start of a SafeArray descriptor */
86 #define SAFEARRAY_HIDDEN_SIZE sizeof(GUID)
88 /* Allocate memory */
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);
97 /* Free memory */
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)
106 switch (vt)
108 case VT_I1:
109 case VT_UI1: return sizeof(BYTE);
110 case VT_BOOL:
111 case VT_I2:
112 case VT_UI2: return sizeof(SHORT);
113 case VT_I4:
114 case VT_UI4:
115 case VT_R4:
116 case VT_ERROR: return sizeof(LONG);
117 case VT_R8:
118 case VT_I8:
119 case VT_UI8: return sizeof(LONG64);
120 case VT_INT:
121 case VT_UINT: return sizeof(INT);
122 case VT_INT_PTR:
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;
136 return 0;
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;
144 lpDw[-1] = dw;
147 /* Get the hidden data from an array */
148 static inline DWORD SAFEARRAY_GetHiddenDWORD(SAFEARRAY* psa)
150 LPDWORD lpDw = (LPDWORD)psa;
151 return lpDw[-1];
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;
161 while (cCount--)
163 /* This is a valid bordercase. See testcases. -Marcus */
164 if (!psab->cElements)
165 return 0;
166 ulNumCells *= psab->cElements;
167 psab++;
169 return ulNumCells;
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);
177 if (!ptr)
179 *ppsaOut = NULL;
180 return E_UNEXPECTED;
183 *ppsaOut = (SAFEARRAY*)(ptr + SAFEARRAY_HIDDEN_SIZE);
184 return S_OK;
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;
203 else
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;
214 unsigned int i;
216 if (!rgsabound)
217 return NULL;
219 if (SUCCEEDED(SafeArrayAllocDescriptorEx(vt, cDims, &psa)))
221 switch (vt)
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));
232 if (ulSize)
233 psa->cbElements = ulSize;
235 if (!psa->cbElements || FAILED(SafeArrayAllocData(psa)))
237 SafeArrayDestroyDescriptor(psa);
238 psa = NULL;
241 return 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);
256 psa->cDims = 1;
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;
263 switch (vt)
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;
272 return psa;
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);
284 return E_UNEXPECTED;
287 ulCellCount -= ulStartCell;
289 if (psa->fFeatures & (FADF_UNKNOWN|FADF_DISPATCH))
291 LPUNKNOWN *lpUnknown = (LPUNKNOWN *)psa->pvData + ulStartCell;
293 while(ulCellCount--)
295 if (*lpUnknown)
296 IUnknown_Release(*lpUnknown);
297 lpUnknown++;
300 else if (psa->fFeatures & (FADF_RECORD))
302 IRecordInfo *lpRecInfo;
304 if (SUCCEEDED(SafeArrayGetRecordInfo(psa, &lpRecInfo)))
306 PBYTE pRecordData = psa->pvData;
307 while(ulCellCount--)
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;
319 while(ulCellCount--)
321 SysFreeString(*lpBstr);
322 lpBstr++;
325 else if (psa->fFeatures & FADF_VARIANT)
327 VARIANT* lpVariant = (VARIANT*)psa->pvData + ulStartCell;
329 while(ulCellCount--)
331 HRESULT hRet = VariantClear(lpVariant);
333 if (FAILED(hRet)) FIXME("VariantClear of element failed!\n");
334 lpVariant++;
338 return S_OK;
341 /* Copy data items from one array to another */
342 static HRESULT SAFEARRAY_CopyData(SAFEARRAY *psa, SAFEARRAY *dest)
344 if (!psa->pvData)
345 return S_OK;
346 else if (!dest->pvData || psa->fFeatures & FADF_DATADELETED)
347 return E_INVALIDARG;
348 else
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;
360 while(ulCellCount--)
362 HRESULT hRet;
364 hRet = VariantCopy(lpDest, lpVariant);
365 if (FAILED(hRet)) FIXME("VariantCopy failed with 0x%x\n", hRet);
366 lpVariant++;
367 lpDest++;
370 else if (psa->fFeatures & FADF_BSTR)
372 BSTR* lpBstr = psa->pvData;
373 BSTR* lpDest = dest->pvData;
375 while(ulCellCount--)
377 if (*lpBstr)
379 *lpDest = SysAllocStringByteLen((char*)*lpBstr, SysStringByteLen(*lpBstr));
380 if (!*lpDest)
381 return E_OUTOFMEMORY;
383 else
384 *lpDest = NULL;
385 lpBstr++;
386 lpDest++;
389 else
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;
398 while(ulCellCount--)
400 if (*lpUnknown)
401 IUnknown_AddRef(*lpUnknown);
402 lpUnknown++;
407 if (psa->fFeatures & FADF_RECORD)
409 IRecordInfo* pRecInfo = NULL;
411 SafeArrayGetRecordInfo(psa, &pRecInfo);
412 SafeArraySetRecordInfo(dest, pRecInfo);
414 if (pRecInfo)
416 /* Release because Get() adds a reference */
417 IRecordInfo_Release(pRecInfo);
420 else if (psa->fFeatures & FADF_HAVEIID)
422 GUID guid;
423 SafeArrayGetIID(psa, &guid);
424 SafeArraySetIID(dest, &guid);
426 else if (psa->fFeatures & FADF_HAVEVARTYPE)
428 SAFEARRAY_SetHiddenDWORD(dest, SAFEARRAY_GetHiddenDWORD(psa));
431 return S_OK;
434 /*************************************************************************
435 * SafeArrayAllocDescriptor (OLEAUT32.36)
437 * Allocate and initialise a descriptor for a SafeArray.
439 * PARAMS
440 * cDims [I] Number of dimensions of the array
441 * ppsaOut [O] Destination for new descriptor
443 * RETURNS
444 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
445 * Failure: An HRESULT error code indicating the error.
447 * NOTES
448 * See SafeArray.
450 HRESULT WINAPI SafeArrayAllocDescriptor(UINT cDims, SAFEARRAY **ppsaOut)
452 LONG allocSize;
454 TRACE("(%d,%p)\n", cDims, ppsaOut);
456 if (!cDims || cDims >= 0x10000) /* Maximum 65535 dimensions */
457 return E_INVALIDARG;
459 if (!ppsaOut)
460 return E_POINTER;
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)))
466 return E_UNEXPECTED;
468 (*ppsaOut)->cDims = cDims;
470 TRACE("(%d): %u bytes allocated for descriptor.\n", cDims, allocSize);
471 return S_OK;
474 /*************************************************************************
475 * SafeArrayAllocDescriptorEx (OLEAUT32.41)
477 * Allocate and initialise a descriptor for a SafeArray of a given type.
479 * PARAMS
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
484 * RETURNS
485 * Success: S_OK. ppsaOut is filled with a newly allocated descriptor.
486 * Failure: An HRESULT error code indicating the error.
488 * NOTES
489 * - This function does not check that vt is an allowed VARTYPE.
490 * - Unlike SafeArrayAllocDescriptor(), vt is associated with the array.
491 * See SafeArray.
493 HRESULT WINAPI SafeArrayAllocDescriptorEx(VARTYPE vt, UINT cDims, SAFEARRAY **ppsaOut)
495 ULONG cbElements;
496 HRESULT hRet = E_UNEXPECTED;
498 TRACE("(%d->%s,%d,%p)\n", vt, debugstr_vt(vt), cDims, ppsaOut);
500 cbElements = SAFEARRAY_GetVTSize(vt);
501 if (!cbElements)
502 WARN("Creating a descriptor with an invalid VARTYPE!\n");
504 hRet = SafeArrayAllocDescriptor(cDims, ppsaOut);
506 if (SUCCEEDED(hRet))
508 SAFEARRAY_SetFeatures(vt, *ppsaOut);
509 (*ppsaOut)->cbElements = cbElements;
511 return hRet;
514 /*************************************************************************
515 * SafeArrayAllocData (OLEAUT32.37)
517 * Allocate the data area of a SafeArray.
519 * PARAMS
520 * psa [I] SafeArray to allocate the data area of.
522 * RETURNS
523 * Success: S_OK. The data area is allocated and initialised.
524 * Failure: An HRESULT error code indicating the error.
526 * NOTES
527 * See SafeArray.
529 HRESULT WINAPI SafeArrayAllocData(SAFEARRAY *psa)
531 HRESULT hRet = E_INVALIDARG;
533 TRACE("(%p)\n", psa);
535 if (psa)
537 ULONG ulSize = SAFEARRAY_GetCellCount(psa);
539 psa->pvData = SAFEARRAY_Malloc(ulSize * psa->cbElements);
541 if (psa->pvData)
543 hRet = S_OK;
544 TRACE("%u bytes allocated for data at %p (%u objects).\n",
545 ulSize * psa->cbElements, psa->pvData, ulSize);
547 else
548 hRet = E_OUTOFMEMORY;
550 return hRet;
553 /*************************************************************************
554 * SafeArrayCreate (OLEAUT32.15)
556 * Create a new SafeArray.
558 * PARAMS
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
563 * RETURNS
564 * Success: A pointer to a new array object.
565 * Failure: NULL, if any parameter is invalid or memory allocation fails.
567 * NOTES
568 * Win32 allows arrays with 0 sized dimensions. This bug is not reproduced
569 * in the Wine implementation.
570 * See SafeArray.
572 SAFEARRAY* WINAPI SafeArrayCreate(VARTYPE vt, UINT cDims, SAFEARRAYBOUND *rgsabound)
574 TRACE("(%d->%s,%d,%p)\n", vt, debugstr_vt(vt), cDims, rgsabound);
576 if (vt == VT_RECORD)
577 return NULL;
579 return SAFEARRAY_Create(vt, cDims, rgsabound, 0);
582 /*************************************************************************
583 * SafeArrayCreateEx (OLEAUT32.15)
585 * Create a new SafeArray.
587 * PARAMS
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
593 * RETURNS
594 * Success: A pointer to a new array object.
595 * Failure: NULL, if any parameter is invalid or memory allocation fails.
597 * NOTES
598 * See SafeArray.
600 SAFEARRAY* WINAPI SafeArrayCreateEx(VARTYPE vt, UINT cDims, SAFEARRAYBOUND *rgsabound, LPVOID pvExtra)
602 ULONG ulSize = 0;
603 IRecordInfo* iRecInfo = pvExtra;
604 SAFEARRAY* psa;
606 TRACE("(%d->%s,%d,%p,%p)\n", vt, debugstr_vt(vt), cDims, rgsabound, pvExtra);
608 if (vt == VT_RECORD)
610 if (!iRecInfo)
611 return NULL;
612 IRecordInfo_GetSize(iRecInfo, &ulSize);
614 psa = SAFEARRAY_Create(vt, cDims, rgsabound, ulSize);
616 if (pvExtra)
618 switch(vt)
620 case VT_RECORD:
621 SafeArraySetRecordInfo(psa, pvExtra);
622 break;
623 case VT_UNKNOWN:
624 case VT_DISPATCH:
625 SafeArraySetIID(psa, pvExtra);
626 break;
629 return psa;
632 /************************************************************************
633 * SafeArrayCreateVector (OLEAUT32.411)
635 * Create a one dimensional, contiguous SafeArray.
637 * PARAMS
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
642 * RETURNS
643 * Success: A pointer to a new array object.
644 * Failure: NULL, if any parameter is invalid or memory allocation fails.
646 * NOTES
647 * See SafeArray.
649 SAFEARRAY* WINAPI SafeArrayCreateVector(VARTYPE vt, LONG lLbound, ULONG cElements)
651 TRACE("(%d->%s,%d,%d\n", vt, debugstr_vt(vt), lLbound, cElements);
653 if (vt == VT_RECORD)
654 return NULL;
656 return SAFEARRAY_CreateVector(vt, lLbound, cElements, SAFEARRAY_GetVTSize(vt));
659 /************************************************************************
660 * SafeArrayCreateVectorEx (OLEAUT32.411)
662 * Create a one dimensional, contiguous SafeArray.
664 * PARAMS
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
670 * RETURNS
671 * Success: A pointer to a new array object.
672 * Failure: NULL, if any parameter is invalid or memory allocation fails.
674 * NOTES
675 * See SafeArray.
677 SAFEARRAY* WINAPI SafeArrayCreateVectorEx(VARTYPE vt, LONG lLbound, ULONG cElements, LPVOID pvExtra)
679 ULONG ulSize;
680 IRecordInfo* iRecInfo = pvExtra;
681 SAFEARRAY* psa;
683 TRACE("(%d->%s,%d,%d,%p\n", vt, debugstr_vt(vt), lLbound, cElements, pvExtra);
685 if (vt == VT_RECORD)
687 if (!iRecInfo)
688 return NULL;
689 IRecordInfo_GetSize(iRecInfo, &ulSize);
691 else
692 ulSize = SAFEARRAY_GetVTSize(vt);
694 psa = SAFEARRAY_CreateVector(vt, lLbound, cElements, ulSize);
696 if (pvExtra)
698 switch(vt)
700 case VT_RECORD:
701 SafeArraySetRecordInfo(psa, iRecInfo);
702 break;
703 case VT_UNKNOWN:
704 case VT_DISPATCH:
705 SafeArraySetIID(psa, pvExtra);
706 break;
709 return psa;
712 /*************************************************************************
713 * SafeArrayDestroyDescriptor (OLEAUT32.38)
715 * Destroy a SafeArray.
717 * PARAMS
718 * psa [I] SafeArray to destroy.
720 * RETURNS
721 * Success: S_OK. The resources used by the array are freed.
722 * Failure: An HRESULT error code indicating the error.
724 * NOTES
725 * See SafeArray.
727 HRESULT WINAPI SafeArrayDestroyDescriptor(SAFEARRAY *psa)
729 TRACE("(%p)\n", psa);
731 if (psa)
733 LPVOID lpv = (char*)psa - SAFEARRAY_HIDDEN_SIZE;
735 if (psa->cLocks)
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))
746 return E_UNEXPECTED;
748 return S_OK;
751 /*************************************************************************
752 * SafeArrayLock (OLEAUT32.21)
754 * Increment the lock counter of a SafeArray.
756 * PARAMS
757 * psa [O] SafeArray to lock
759 * RETURNS
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.
764 * NOTES
765 * In Win32 these locks are not thread safe.
766 * See SafeArray.
768 HRESULT WINAPI SafeArrayLock(SAFEARRAY *psa)
770 ULONG ulLocks;
772 TRACE("(%p)\n", psa);
774 if (!psa)
775 return E_INVALIDARG;
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);
783 return E_UNEXPECTED;
785 return S_OK;
788 /*************************************************************************
789 * SafeArrayUnlock (OLEAUT32.22)
791 * Decrement the lock counter of a SafeArray.
793 * PARAMS
794 * psa [O] SafeArray to unlock
796 * RETURNS
797 * Success: S_OK. The array lock is decremented.
798 * Failure: E_INVALIDARG if psa is NULL, or E_UNEXPECTED if no locks are
799 * held on the array.
801 * NOTES
802 * See SafeArray.
804 HRESULT WINAPI SafeArrayUnlock(SAFEARRAY *psa)
806 TRACE("(%p)\n", psa);
808 if (!psa)
809 return E_INVALIDARG;
811 if (InterlockedDecrement( (LONG*) &psa->cLocks) < 0)
813 WARN("Unlocked but no lock held!\n");
814 InterlockedIncrement( (LONG*) &psa->cLocks);
815 return E_UNEXPECTED;
817 return S_OK;
820 /*************************************************************************
821 * SafeArrayPutElement (OLEAUT32.26)
823 * Put an item into a SafeArray.
825 * PARAMS
826 * psa [I] SafeArray to insert into
827 * rgIndices [I] Indices to insert at
828 * pvData [I] Data to insert
830 * RETURNS
831 * Success: S_OK. The item is inserted
832 * Failure: An HRESULT error code indicating the error.
834 * NOTES
835 * See SafeArray.
837 HRESULT WINAPI SafeArrayPutElement(SAFEARRAY *psa, LONG *rgIndices, void *pvData)
839 HRESULT hRet;
841 TRACE("(%p,%p,%p)\n", psa, rgIndices, pvData);
843 if (!psa || !rgIndices)
844 return E_INVALIDARG;
846 hRet = SafeArrayLock(psa);
848 if (SUCCEEDED(hRet))
850 PVOID lpvDest;
852 hRet = SafeArrayPtrOfIndex(psa, rgIndices, &lpvDest);
854 if (SUCCEEDED(hRet))
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));
874 if (!*lpDest)
875 hRet = E_OUTOFMEMORY;
877 else
879 if (psa->fFeatures & (FADF_UNKNOWN|FADF_DISPATCH))
881 LPUNKNOWN lpUnknown = pvData;
882 LPUNKNOWN *lpDest = lpvDest;
884 if (lpUnknown)
885 IUnknown_AddRef(lpUnknown);
886 if (*lpDest)
887 IUnknown_Release(*lpDest);
888 *lpDest = lpUnknown;
889 } else {
890 /* Copy the data over */
891 memcpy(lpvDest, pvData, psa->cbElements);
895 SafeArrayUnlock(psa);
897 return hRet;
901 /*************************************************************************
902 * SafeArrayGetElement (OLEAUT32.25)
904 * Get an item from a SafeArray.
906 * PARAMS
907 * psa [I] SafeArray to get from
908 * rgIndices [I] Indices to get from
909 * pvData [O] Destination for data
911 * RETURNS
912 * Success: S_OK. The item data is returned in pvData.
913 * Failure: An HRESULT error code indicating the error.
915 * NOTES
916 * See SafeArray.
918 HRESULT WINAPI SafeArrayGetElement(SAFEARRAY *psa, LONG *rgIndices, void *pvData)
920 HRESULT hRet;
922 TRACE("(%p,%p,%p)\n", psa, rgIndices, pvData);
924 if (!psa || !rgIndices || !pvData)
925 return E_INVALIDARG;
927 hRet = SafeArrayLock(psa);
929 if (SUCCEEDED(hRet))
931 PVOID lpvSrc;
933 hRet = SafeArrayPtrOfIndex(psa, rgIndices, &lpvSrc);
935 if (SUCCEEDED(hRet))
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;
952 if (*lpBstr)
954 *lpDest = SysAllocStringByteLen((char*)*lpBstr, SysStringByteLen(*lpBstr));
955 if (!*lpBstr)
956 hRet = E_OUTOFMEMORY;
958 else
959 *lpDest = NULL;
961 else
963 if (psa->fFeatures & (FADF_UNKNOWN|FADF_DISPATCH))
965 LPUNKNOWN *lpUnknown = lpvSrc;
967 if (*lpUnknown)
968 IUnknown_AddRef(*lpUnknown);
970 /* Copy the data over */
971 memcpy(pvData, lpvSrc, psa->cbElements);
974 SafeArrayUnlock(psa);
976 return hRet;
979 /*************************************************************************
980 * SafeArrayGetUBound (OLEAUT32.19)
982 * Get the upper bound for a given SafeArray dimension
984 * PARAMS
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
989 * RETURNS
990 * Success: S_OK. plUbound contains the dimensions upper bound.
991 * Failure: An HRESULT error code indicating the error.
993 * NOTES
994 * See SafeArray.
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;
1009 return S_OK;
1012 /*************************************************************************
1013 * SafeArrayGetLBound (OLEAUT32.20)
1015 * Get the lower bound for a given SafeArray dimension
1017 * PARAMS
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
1022 * RETURNS
1023 * Success: S_OK. plUbound contains the dimensions lower bound.
1024 * Failure: An HRESULT error code indicating the error.
1026 * NOTES
1027 * See SafeArray.
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;
1040 return S_OK;
1043 /*************************************************************************
1044 * SafeArrayGetDim (OLEAUT32.17)
1046 * Get the number of dimensions in a SafeArray.
1048 * PARAMS
1049 * psa [I] Array to get the dimensions of
1051 * RETURNS
1052 * The number of array dimensions in psa, or 0 if psa is NULL.
1054 * NOTES
1055 * See SafeArray.
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.
1068 * PARAMS
1069 * psa [I] Array to get the element size from
1071 * RETURNS
1072 * The size of a single element in psa, or 0 if psa is NULL.
1074 * NOTES
1075 * See SafeArray.
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.
1088 * PARAMS
1089 * psa [I] Array to get the data pointer from
1090 * ppvData [O] Destination for the arrays data pointer
1092 * RETURNS
1093 * Success: S_OK. ppvData contains the arrays data pointer, and the array
1094 * is locked.
1095 * Failure: An HRESULT error code indicating the error.
1097 * NOTES
1098 * See SafeArray.
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;
1110 return S_OK;
1112 *ppvData = NULL;
1113 return E_UNEXPECTED;
1117 /*************************************************************************
1118 * SafeArrayUnaccessData (OLEAUT32.24)
1120 * Unlock a SafeArray after accessing its data.
1122 * PARAMS
1123 * psa [I] Array to unlock
1125 * RETURNS
1126 * Success: S_OK. The array is unlocked.
1127 * Failure: An HRESULT error code indicating the error.
1129 * NOTES
1130 * See SafeArray.
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.
1143 * PARAMS
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
1148 * RETURNS
1149 * Success: S_OK. ppvData contains a pointer to the item.
1150 * Failure: An HRESULT error code indicating the error.
1152 * NOTES
1153 * This function does not lock the array.
1155 * NOTES
1156 * See SafeArray.
1158 HRESULT WINAPI SafeArrayPtrOfIndex(SAFEARRAY *psa, LONG *rgIndices, void **ppvData)
1160 USHORT dim;
1161 ULONG cell = 0, dimensionSize = 1;
1162 SAFEARRAYBOUND* psab;
1163 LONG c1;
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;
1179 c1 = *rgIndices++;
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;
1188 psab--;
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;
1196 rgIndices++;
1199 cell += (c1 - psa->rgsabound[psa->cDims - 1].lLbound);
1201 *ppvData = (char*)psa->pvData + cell * psa->cbElements;
1202 return S_OK;
1205 /************************************************************************
1206 * SafeArrayDestroyData (OLEAUT32.39)
1208 * Destroy the data associated with a SafeArray.
1210 * PARAMS
1211 * psa [I] Array to delete the data from
1213 * RETURNS
1214 * Success: S_OK. All items and the item data are freed.
1215 * Failure: An HRESULT error code indicating the error.
1217 * NOTES
1218 * See SafeArray.
1220 HRESULT WINAPI SafeArrayDestroyData(SAFEARRAY *psa)
1222 TRACE("(%p)\n", psa);
1224 if (!psa)
1225 return E_INVALIDARG;
1227 if (psa->cLocks)
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;
1234 if (psa->pvData)
1236 if (psa->fFeatures & FADF_STATIC)
1238 ZeroMemory(psa->pvData, SAFEARRAY_GetCellCount(psa) * psa->cbElements);
1239 return S_OK;
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;
1246 psa->pvData = NULL;
1248 else
1249 psa->fFeatures |= FADF_DATADELETED; /* Mark the data deleted */
1252 return S_OK;
1255 /************************************************************************
1256 * SafeArrayCopyData (OLEAUT32.412)
1258 * Copy all data from one SafeArray to another.
1260 * PARAMS
1261 * psaSource [I] Source for copy
1262 * psaTarget [O] Destination for copy
1264 * RETURNS
1265 * Success: S_OK. psaTarget contains a copy of psaSource.
1266 * Failure: An HRESULT error code indicating the error.
1268 * NOTES
1269 * The two arrays must have the same number of dimensions and elements.
1271 * NOTES
1272 * See SafeArray.
1274 HRESULT WINAPI SafeArrayCopyData(SAFEARRAY *psaSource, SAFEARRAY *psaTarget)
1276 int dim;
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)))
1293 return S_OK;
1294 return E_UNEXPECTED;
1297 /************************************************************************
1298 * SafeArrayDestroy (OLEAUT32.16)
1300 * Destroy a SafeArray.
1302 * PARAMS
1303 * psa [I] Array to destroy
1305 * RETURNS
1306 * Success: S_OK. All resources used by the array are freed.
1307 * Failure: An HRESULT error code indicating the error.
1309 * NOTES
1310 * See SafeArray.
1312 HRESULT WINAPI SafeArrayDestroy(SAFEARRAY *psa)
1314 TRACE("(%p)\n", psa);
1316 if(!psa)
1317 return S_OK;
1319 if(psa->cLocks > 0)
1320 return DISP_E_ARRAYISLOCKED;
1322 /* Native doesn't check to see if the free succeeds */
1323 SafeArrayDestroyData(psa);
1324 SafeArrayDestroyDescriptor(psa);
1325 return S_OK;
1328 /************************************************************************
1329 * SafeArrayCopy (OLEAUT32.27)
1331 * Make a duplicate of a SafeArray.
1333 * PARAMS
1334 * psa [I] Source for copy
1335 * ppsaOut [O] Destination for new copy
1337 * RETURNS
1338 * Success: S_OK. ppsaOut contains a copy of the array.
1339 * Failure: An HRESULT error code indicating the error.
1341 * NOTES
1342 * See SafeArray.
1344 HRESULT WINAPI SafeArrayCopy(SAFEARRAY *psa, SAFEARRAY **ppsaOut)
1346 HRESULT hRet;
1348 TRACE("(%p,%p)\n", psa, ppsaOut);
1350 if (!ppsaOut)
1351 return E_INVALIDARG;
1353 *ppsaOut = NULL;
1355 if (!psa)
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))
1363 VARTYPE vt;
1364 if (FAILED(SafeArrayGetVartype(psa, &vt)))
1365 hRet = E_UNEXPECTED;
1366 else
1367 hRet = SafeArrayAllocDescriptorEx(vt, psa->cDims, ppsaOut);
1369 else
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))
1391 return hRet;
1393 SAFEARRAY_Free((*ppsaOut)->pvData);
1395 SafeArrayDestroyDescriptor(*ppsaOut);
1397 *ppsaOut = NULL;
1398 return hRet;
1401 /************************************************************************
1402 * SafeArrayRedim (OLEAUT32.40)
1404 * Changes the characteristics of the last dimension of a SafeArray
1406 * PARAMS
1407 * psa [I] Array to change
1408 * psabound [I] New bound details for the last dimension
1410 * RETURNS
1411 * Success: S_OK. psa is updated to reflect the new bounds.
1412 * Failure: An HRESULT error code indicating the error.
1414 * NOTES
1415 * See SafeArray.
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);
1444 else
1446 /* Lengthen the final dimension */
1447 ULONG ulOldSize, ulNewSize;
1448 PVOID pvNewData;
1450 ulOldSize = SAFEARRAY_GetCellCount(psa) * psa->cbElements;
1451 if (ulOldSize)
1452 ulNewSize = (ulOldSize / oldBounds->cElements) * psabound->cElements;
1453 else {
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);
1474 return S_OK;
1477 /************************************************************************
1478 * SafeArrayGetVartype (OLEAUT32.77)
1480 * Get the type of the items in a SafeArray.
1482 * PARAMS
1483 * psa [I] Array to get the type from
1484 * pvt [O] Destination for the type
1486 * RETURNS
1487 * Success: S_OK. pvt contains the type of the items.
1488 * Failure: An HRESULT error code indicating the error.
1490 * NOTES
1491 * See SafeArray.
1493 HRESULT WINAPI SafeArrayGetVartype(SAFEARRAY* psa, VARTYPE* pvt)
1495 TRACE("(%p,%p)\n", psa, pvt);
1497 if (!psa || !pvt)
1498 return E_INVALIDARG;
1500 if (psa->fFeatures & FADF_RECORD)
1501 *pvt = VT_RECORD;
1502 else if ((psa->fFeatures & (FADF_HAVEIID|FADF_DISPATCH)) == (FADF_HAVEIID|FADF_DISPATCH))
1503 *pvt = VT_DISPATCH;
1504 else if (psa->fFeatures & FADF_HAVEIID)
1505 *pvt = VT_UNKNOWN;
1506 else if (psa->fFeatures & FADF_HAVEVARTYPE)
1508 VARTYPE vt = SAFEARRAY_GetHiddenDWORD(psa);
1509 *pvt = vt;
1511 else
1512 return E_INVALIDARG;
1514 return S_OK;
1517 /************************************************************************
1518 * SafeArraySetRecordInfo (OLEAUT32.@)
1520 * Set the record info for a SafeArray.
1522 * PARAMS
1523 * psa [I] Array to set the record info for
1524 * pRinfo [I] Record info
1526 * RETURNS
1527 * Success: S_OK. The record info is stored with the array.
1528 * Failure: An HRESULT error code indicating the error.
1530 * NOTES
1531 * See SafeArray.
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;
1542 if (pRinfo)
1543 IRecordInfo_AddRef(pRinfo);
1545 if (dest[-1])
1546 IRecordInfo_Release(dest[-1]);
1548 dest[-1] = pRinfo;
1549 return S_OK;
1552 /************************************************************************
1553 * SafeArrayGetRecordInfo (OLEAUT32.@)
1555 * Get the record info from a SafeArray.
1557 * PARAMS
1558 * psa [I] Array to get the record info from
1559 * pRinfo [O] Destination for the record info
1561 * RETURNS
1562 * Success: S_OK. pRinfo contains the record info, or NULL if there was none.
1563 * Failure: An HRESULT error code indicating the error.
1565 * NOTES
1566 * See SafeArray.
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;
1577 *pRinfo = src[-1];
1579 if (*pRinfo)
1580 IRecordInfo_AddRef(*pRinfo);
1581 return S_OK;
1584 /************************************************************************
1585 * SafeArraySetIID (OLEAUT32.@)
1587 * Set the IID for a SafeArray.
1589 * PARAMS
1590 * psa [I] Array to set the IID from
1591 * guid [I] IID
1593 * RETURNS
1594 * Success: S_OK. The IID is stored with the array
1595 * Failure: An HRESULT error code indicating the error.
1597 * NOTES
1598 * See SafeArray.
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;
1609 dest[-1] = *guid;
1610 return S_OK;
1613 /************************************************************************
1614 * SafeArrayGetIID (OLEAUT32.@)
1616 * Get the IID from a SafeArray.
1618 * PARAMS
1619 * psa [I] Array to get the ID from
1620 * pGuid [O] Destination for the IID
1622 * RETURNS
1623 * Success: S_OK. pRinfo contains the IID, or NULL if there was none.
1624 * Failure: An HRESULT error code indicating the error.
1626 * NOTES
1627 * See SafeArray.
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;
1638 *pGuid = src[-1];
1639 return S_OK;
1642 /************************************************************************
1643 * VectorFromBstr (OLEAUT32.@)
1645 * Create a SafeArray Vector from the bytes of a BSTR.
1647 * PARAMS
1648 * bstr [I] String to get bytes from
1649 * ppsa [O] Destination for the array
1651 * RETURNS
1652 * Success: S_OK. ppsa contains the strings bytes as a VT_UI1 array.
1653 * Failure: An HRESULT error code indicating the error.
1655 * NOTES
1656 * See SafeArray.
1658 HRESULT WINAPI VectorFromBstr(BSTR bstr, SAFEARRAY **ppsa)
1660 SAFEARRAYBOUND sab;
1662 TRACE("(%p,%p)\n", bstr, ppsa);
1664 if (!ppsa)
1665 return E_INVALIDARG;
1667 sab.lLbound = 0;
1668 sab.cElements = SysStringByteLen(bstr);
1670 *ppsa = SAFEARRAY_Create(VT_UI1, 1, &sab, 0);
1672 if (*ppsa)
1674 memcpy((*ppsa)->pvData, bstr, sab.cElements);
1675 return S_OK;
1677 return E_OUTOFMEMORY;
1680 /************************************************************************
1681 * BstrFromVector (OLEAUT32.@)
1683 * Create a BSTR from a SafeArray.
1685 * PARAMS
1686 * psa [I] Source array
1687 * pbstr [O] Destination for output BSTR
1689 * RETURNS
1690 * Success: S_OK. pbstr contains the arrays data.
1691 * Failure: An HRESULT error code indicating the error.
1693 * NOTES
1694 * psa must be a 1 dimensional array of a 1 byte type.
1696 * NOTES
1697 * See SafeArray.
1699 HRESULT WINAPI BstrFromVector(SAFEARRAY *psa, BSTR *pbstr)
1701 TRACE("(%p,%p)\n", psa, pbstr);
1703 if (!pbstr)
1704 return E_INVALIDARG;
1706 *pbstr = NULL;
1708 if (!psa || psa->cbElements != 1 || psa->cDims != 1)
1709 return E_INVALIDARG;
1711 *pbstr = SysAllocStringByteLen(psa->pvData, psa->rgsabound[0].cElements);
1712 if (!*pbstr)
1713 return E_OUTOFMEMORY;
1714 return S_OK;