4 * Copyright 2004 Jon Griffiths
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #define NONAMELESSUNION
23 #define NONAMELESSSTRUCT
31 #include "wine/debug.h"
32 #include "wine/unicode.h"
35 WINE_DEFAULT_DEBUG_CHANNEL(mapi);
37 BOOL WINAPI FBadRglpszA(LPSTR*,ULONG);
38 BOOL WINAPI FBadRglpszW(LPWSTR*,ULONG);
40 /* Internal: Check if a property value array is invalid */
41 static inline ULONG PROP_BadArray(LPSPropValue lpProp, size_t elemSize)
43 return IsBadReadPtr(lpProp->Value.MVi.lpi, lpProp->Value.MVi.cValues * elemSize);
46 /*************************************************************************
47 * PropCopyMore@16 (MAPI32.76)
49 * Copy a property value.
52 * lpDest [O] Destination for the copied value
53 * lpSrc [I] Property value to copy to lpDest
54 * lpMore [I] Linked memory allocation function (pass MAPIAllocateMore())
55 * lpOrig [I] Original allocation to which memory will be linked
58 * Success: S_OK. lpDest contains a deep copy of lpSrc.
59 * Failure: MAPI_E_INVALID_PARAMETER, if any parameter is invalid,
60 * MAPI_E_NOT_ENOUGH_MEMORY, if memory allocation fails.
63 * Any elements within the property returned should not be individually
64 * freed, as they will be freed when lpOrig is.
66 SCODE WINAPI PropCopyMore(LPSPropValue lpDest, LPSPropValue lpSrc,
67 ALLOCATEMORE *lpMore, LPVOID lpOrig)
72 TRACE("(%p,%p,%p,%p)\n", lpDest, lpSrc, lpMore, lpOrig);
74 if (!lpDest || IsBadWritePtr(lpDest, sizeof(SPropValue)) ||
75 FBadProp(lpSrc) || !lpMore)
76 return MAPI_E_INVALID_PARAMETER;
78 /* Shallow copy first, this is sufficient for properties without pointers */
81 switch (PROP_TYPE(lpSrc->ulPropTag))
84 scode = lpMore(sizeof(GUID), lpOrig, (LPVOID*)&lpDest->Value.lpguid);
86 memcpy(lpDest->Value.lpguid, lpSrc->Value.lpguid, sizeof(GUID));
89 ulLen = lstrlenA(lpSrc->Value.lpszA) + 1u;
90 scode = lpMore(ulLen, lpOrig, (LPVOID*)&lpDest->Value.lpszA);
92 memcpy(lpDest->Value.lpszA, lpSrc->Value.lpszA, ulLen);
95 ulLen = (strlenW(lpSrc->Value.lpszW) + 1u) * sizeof(WCHAR);
96 scode = lpMore(ulLen, lpOrig, (LPVOID*)&lpDest->Value.lpszW);
98 memcpy(lpDest->Value.lpszW, lpSrc->Value.lpszW, ulLen);
101 scode = lpMore(lpSrc->Value.bin.cb, lpOrig, (LPVOID*)&lpDest->Value.bin.lpb);
102 if (SUCCEEDED(scode))
103 memcpy(lpDest->Value.bin.lpb, lpSrc->Value.bin.lpb, lpSrc->Value.bin.cb);
106 if (lpSrc->ulPropTag & MV_FLAG)
108 ulLen = UlPropSize(lpSrc);
110 if (PROP_TYPE(lpSrc->ulPropTag) == PT_MV_STRING8 ||
111 PROP_TYPE(lpSrc->ulPropTag) == PT_MV_UNICODE)
113 /* UlPropSize doesn't account for the string pointers */
114 ulLen += lpSrc->Value.MVszA.cValues * sizeof(char*);
116 else if (PROP_TYPE(lpSrc->ulPropTag) == PT_MV_BINARY)
118 /* UlPropSize doesn't account for the SBinary structs */
119 ulLen += lpSrc->Value.MVbin.cValues * sizeof(SBinary);
122 lpDest->Value.MVi.cValues = lpSrc->Value.MVi.cValues;
123 scode = lpMore(ulLen, lpOrig, (LPVOID*)&lpDest->Value.MVi.lpi);
127 /* Note that we could allocate the memory for each value in a
128 * multi-value property seperately, however if an allocation failed
129 * we would be left with a bunch of allocated memory, which (while
130 * not really leaked) is unusable until lpOrig is freed. So for
131 * strings and binary arrays we make a single allocation for all
132 * of the data. This is consistent since individual elements can't
136 switch (PROP_TYPE(lpSrc->ulPropTag))
140 char *lpNextStr = (char*)(lpDest->Value.MVszA.lppszA +
141 lpDest->Value.MVszA.cValues);
143 for (i = 0; i < lpSrc->Value.MVszA.cValues; i++)
145 ULONG ulStrLen = lstrlenA(lpSrc->Value.MVszA.lppszA[i]) + 1u;
147 lpDest->Value.MVszA.lppszA[i] = lpNextStr;
148 memcpy(lpNextStr, lpSrc->Value.MVszA.lppszA[i], ulStrLen);
149 lpNextStr += ulStrLen;
155 WCHAR *lpNextStr = (WCHAR*)(lpDest->Value.MVszW.lppszW +
156 lpDest->Value.MVszW.cValues);
158 for (i = 0; i < lpSrc->Value.MVszW.cValues; i++)
160 ULONG ulStrLen = strlenW(lpSrc->Value.MVszW.lppszW[i]) + 1u;
162 lpDest->Value.MVszW.lppszW[i] = lpNextStr;
163 memcpy(lpNextStr, lpSrc->Value.MVszW.lppszW[i], ulStrLen * sizeof(WCHAR));
164 lpNextStr += ulStrLen;
170 LPBYTE lpNext = (LPBYTE)(lpDest->Value.MVbin.lpbin +
171 lpDest->Value.MVbin.cValues);
173 for (i = 0; i < lpSrc->Value.MVszW.cValues; i++)
175 lpDest->Value.MVbin.lpbin[i].cb = lpSrc->Value.MVbin.lpbin[i].cb;
176 lpDest->Value.MVbin.lpbin[i].lpb = lpNext;
177 memcpy(lpNext, lpSrc->Value.MVbin.lpbin[i].lpb, lpDest->Value.MVbin.lpbin[i].cb);
178 lpNext += lpDest->Value.MVbin.lpbin[i].cb;
183 /* No embedded pointers, just copy the data over */
184 memcpy(lpDest->Value.MVi.lpi, lpSrc->Value.MVi.lpi, ulLen);
193 /*************************************************************************
194 * UlPropSize@4 (MAPI32.77)
196 * Determine the size of a property in bytes.
199 * lpProp [I] Property to determine the size of
202 * Success: The size of the value in lpProp.
203 * Failure: 0, if a multi-value (array) property is invalid or the type of lpProp
207 * - The size returned does not include the size of the SPropValue struct
208 * or the size of the array of pointers for multi-valued properties that
209 * contain pointers (such as PT_MV_STRING8 or PT-MV_UNICODE).
210 * - MSDN incorrectly states that this function returns MAPI_E_CALL_FAILED if
211 * lpProp is invalid. In reality no checking is performed and this function
212 * will crash if passed an invalid property, or return 0 if the property
213 * type is PT_OBJECT or is unknown.
215 ULONG WINAPI UlPropSize(LPSPropValue lpProp)
219 TRACE("(%p)\n", lpProp);
221 switch (PROP_TYPE(lpProp->ulPropTag))
223 case PT_MV_I2: ulRet = lpProp->Value.MVi.cValues;
225 case PT_I2: ulRet *= sizeof(USHORT);
227 case PT_MV_I4: ulRet = lpProp->Value.MVl.cValues;
229 case PT_I4: ulRet *= sizeof(LONG);
231 case PT_MV_I8: ulRet = lpProp->Value.MVli.cValues;
232 case PT_I8: ulRet *= sizeof(LONG64);
234 case PT_MV_R4: ulRet = lpProp->Value.MVflt.cValues;
235 case PT_R4: ulRet *= sizeof(float);
238 case PT_MV_R8: ulRet = lpProp->Value.MVdbl.cValues;
240 case PT_R8: ulRet *= sizeof(double);
242 case PT_MV_CURRENCY: ulRet = lpProp->Value.MVcur.cValues;
243 case PT_CURRENCY: ulRet *= sizeof(CY);
245 case PT_MV_SYSTIME: ulRet = lpProp->Value.MVft.cValues;
246 case PT_SYSTIME: ulRet *= sizeof(FILETIME);
248 case PT_MV_CLSID: ulRet = lpProp->Value.MVguid.cValues;
249 case PT_CLSID: ulRet *= sizeof(GUID);
251 case PT_MV_STRING8: ulRet = 0u;
252 for (i = 0; i < lpProp->Value.MVszA.cValues; i++)
253 ulRet += (lstrlenA(lpProp->Value.MVszA.lppszA[i]) + 1u);
255 case PT_STRING8: ulRet = lstrlenA(lpProp->Value.lpszA) + 1u;
257 case PT_MV_UNICODE: ulRet = 0u;
258 for (i = 0; i < lpProp->Value.MVszW.cValues; i++)
259 ulRet += (strlenW(lpProp->Value.MVszW.lppszW[i]) + 1u);
260 ulRet *= sizeof(WCHAR);
262 case PT_UNICODE: ulRet = (lstrlenW(lpProp->Value.lpszW) + 1u) * sizeof(WCHAR);
264 case PT_MV_BINARY: ulRet = 0u;
265 for (i = 0; i < lpProp->Value.MVbin.cValues; i++)
266 ulRet += lpProp->Value.MVbin.lpbin[i].cb;
268 case PT_BINARY: ulRet = lpProp->Value.bin.cb;
279 /*************************************************************************
280 * FPropContainsProp@12 (MAPI32.78)
282 * Find a property with a given property tag in a property array.
285 * lpHaystack [I] Property to match to
286 * lpNeedle [I] Property to find in lpHaystack
287 * ulFuzzy [I] Flags controlling match type and strictness (FL_* flags from "mapidefs.h")
290 * TRUE, if lpNeedle matches lpHaystack according to the criteria of ulFuzzy.
293 * Only property types of PT_STRING8 and PT_BINARY are handled by this function.
295 BOOL WINAPI FPropContainsProp(LPSPropValue lpHaystack, LPSPropValue lpNeedle, ULONG ulFuzzy)
297 TRACE("(%p,%p,0x%08lx)\n", lpHaystack, lpNeedle, ulFuzzy);
299 if (FBadProp(lpHaystack) || FBadProp(lpNeedle) ||
300 PROP_TYPE(lpHaystack->ulPropTag) != PROP_TYPE(lpNeedle->ulPropTag))
303 /* FIXME: Do later versions support Unicode as well? */
305 if (PROP_TYPE(lpHaystack->ulPropTag) == PT_STRING8)
307 DWORD dwFlags = 0, dwNeedleLen, dwHaystackLen;
309 if (ulFuzzy & FL_IGNORECASE)
310 dwFlags |= NORM_IGNORECASE;
311 if (ulFuzzy & FL_IGNORENONSPACE)
312 dwFlags |= NORM_IGNORENONSPACE;
313 if (ulFuzzy & FL_LOOSE)
314 dwFlags |= (NORM_IGNORECASE|NORM_IGNORENONSPACE|NORM_IGNORESYMBOLS);
316 dwNeedleLen = lstrlenA(lpNeedle->Value.lpszA);
317 dwHaystackLen = lstrlenA(lpHaystack->Value.lpszA);
319 if ((ulFuzzy & (FL_SUBSTRING|FL_PREFIX)) == FL_PREFIX)
321 if (dwNeedleLen <= dwHaystackLen &&
322 CompareStringA(LOCALE_USER_DEFAULT, dwFlags,
323 lpHaystack->Value.lpszA, dwNeedleLen,
324 lpNeedle->Value.lpszA, dwNeedleLen) == CSTR_EQUAL)
325 return TRUE; /* needle is a prefix of haystack */
327 else if ((ulFuzzy & (FL_SUBSTRING|FL_PREFIX)) == FL_SUBSTRING)
329 LPSTR (WINAPI *pStrChrFn)(LPCSTR,WORD) = StrChrA;
330 LPSTR lpStr = lpHaystack->Value.lpszA;
332 if (dwFlags & NORM_IGNORECASE)
333 pStrChrFn = StrChrIA;
335 while ((lpStr = pStrChrFn(lpStr, *lpNeedle->Value.lpszA)) != NULL)
337 dwHaystackLen -= (lpStr - lpHaystack->Value.lpszA);
338 if (dwNeedleLen <= dwHaystackLen &&
339 CompareStringA(LOCALE_USER_DEFAULT, dwFlags,
341 lpNeedle->Value.lpszA, dwNeedleLen) == CSTR_EQUAL)
342 return TRUE; /* needle is a substring of haystack */
346 else if (CompareStringA(LOCALE_USER_DEFAULT, dwFlags,
347 lpHaystack->Value.lpszA, dwHaystackLen,
348 lpNeedle->Value.lpszA, dwNeedleLen) == CSTR_EQUAL)
349 return TRUE; /* full string match */
351 else if (PROP_TYPE(lpHaystack->ulPropTag) == PT_BINARY)
353 if ((ulFuzzy & (FL_SUBSTRING|FL_PREFIX)) == FL_PREFIX)
355 if (lpNeedle->Value.bin.cb <= lpHaystack->Value.bin.cb &&
356 !memcmp(lpNeedle->Value.bin.lpb, lpHaystack->Value.bin.lpb,
357 lpNeedle->Value.bin.cb))
358 return TRUE; /* needle is a prefix of haystack */
360 else if ((ulFuzzy & (FL_SUBSTRING|FL_PREFIX)) == FL_SUBSTRING)
362 ULONG ulLen = lpHaystack->Value.bin.cb;
363 LPBYTE lpb = lpHaystack->Value.bin.lpb;
365 while ((lpb = memchr(lpb, *lpNeedle->Value.bin.lpb, ulLen)) != NULL)
367 ulLen = lpHaystack->Value.bin.cb - (lpb - lpHaystack->Value.bin.lpb);
368 if (lpNeedle->Value.bin.cb <= ulLen &&
369 !memcmp(lpNeedle->Value.bin.lpb, lpb, lpNeedle->Value.bin.cb))
370 return TRUE; /* needle is a substring of haystack */
374 else if (!LPropCompareProp(lpHaystack, lpNeedle))
375 return TRUE; /* needle is an exact match with haystack */
381 /*************************************************************************
382 * FPropCompareProp@12 (MAPI32.79)
384 * Compare two properties.
387 * lpPropLeft [I] Left hand property to compare to lpPropRight
388 * ulOp [I] Comparison operator (RELOP_* enum from "mapidefs.h")
389 * lpPropRight [I] Right hand property to compare to lpPropLeft
392 * TRUE, if the comparison is true, FALSE otherwise.
394 BOOL WINAPI FPropCompareProp(LPSPropValue lpPropLeft, ULONG ulOp, LPSPropValue lpPropRight)
398 TRACE("(%p,%ld,%p)\n", lpPropLeft, ulOp, lpPropRight);
400 if (ulOp > RELOP_RE || FBadProp(lpPropLeft) || FBadProp(lpPropRight))
403 if (ulOp == RELOP_RE)
405 FIXME("Comparison operator RELOP_RE not yet implemented!\n");
409 iCmp = LPropCompareProp(lpPropLeft, lpPropRight);
413 case RELOP_LT: return iCmp < 0 ? TRUE : FALSE;
414 case RELOP_LE: return iCmp <= 0 ? TRUE : FALSE;
415 case RELOP_GT: return iCmp > 0 ? TRUE : FALSE;
416 case RELOP_GE: return iCmp >= 0 ? TRUE : FALSE;
417 case RELOP_EQ: return iCmp == 0 ? TRUE : FALSE;
418 case RELOP_NE: return iCmp != 0 ? TRUE : FALSE;
423 /*************************************************************************
424 * LPropCompareProp@8 (MAPI32.80)
426 * Compare two properties.
429 * lpPropLeft [I] Left hand property to compare to lpPropRight
430 * lpPropRight [I] Right hand property to compare to lpPropLeft
433 * An integer less than, equal to or greater than 0, indicating that
434 * lpszStr is less than, the same, or greater than lpszComp.
436 LONG WINAPI LPropCompareProp(LPSPropValue lpPropLeft, LPSPropValue lpPropRight)
440 TRACE("(%p->0x%08lx,%p->0x%08lx)\n", lpPropLeft, lpPropLeft->ulPropTag,
441 lpPropRight, lpPropRight->ulPropTag);
443 /* If the properties are not the same, sort by property type */
444 if (PROP_TYPE(lpPropLeft->ulPropTag) != PROP_TYPE(lpPropRight->ulPropTag))
445 return (LONG)PROP_TYPE(lpPropLeft->ulPropTag) - (LONG)PROP_TYPE(lpPropRight->ulPropTag);
447 switch (PROP_TYPE(lpPropLeft->ulPropTag))
451 return 0; /* NULLs are equal */
453 return lpPropLeft->Value.i - lpPropRight->Value.i;
455 return lpPropLeft->Value.l - lpPropRight->Value.l;
457 if (lpPropLeft->Value.li.QuadPart > lpPropRight->Value.li.QuadPart)
459 if (lpPropLeft->Value.li.QuadPart == lpPropRight->Value.li.QuadPart)
463 if (lpPropLeft->Value.flt > lpPropRight->Value.flt)
465 if (lpPropLeft->Value.flt == lpPropRight->Value.flt)
470 if (lpPropLeft->Value.dbl > lpPropRight->Value.dbl)
472 if (lpPropLeft->Value.dbl == lpPropRight->Value.dbl)
476 if (lpPropLeft->Value.cur.int64 > lpPropRight->Value.cur.int64)
478 if (lpPropLeft->Value.cur.int64 == lpPropRight->Value.cur.int64)
482 return CompareFileTime(&lpPropLeft->Value.ft, &lpPropRight->Value.ft);
484 return (lpPropLeft->Value.b ? 1 : 0) - (lpPropRight->Value.b ? 1 : 0);
486 if (lpPropLeft->Value.bin.cb == lpPropRight->Value.bin.cb)
487 iRet = memcmp(lpPropLeft->Value.bin.lpb, lpPropRight->Value.bin.lpb,
488 lpPropLeft->Value.bin.cb);
491 iRet = memcmp(lpPropLeft->Value.bin.lpb, lpPropRight->Value.bin.lpb,
492 min(lpPropLeft->Value.bin.cb, lpPropRight->Value.bin.cb));
495 iRet = lpPropLeft->Value.bin.cb - lpPropRight->Value.bin.cb;
499 return lstrcmpA(lpPropLeft->Value.lpszA, lpPropRight->Value.lpszA);
501 return strcmpW(lpPropLeft->Value.lpszW, lpPropRight->Value.lpszW);
503 if (lpPropLeft->Value.err > lpPropRight->Value.err)
505 if (lpPropLeft->Value.err == lpPropRight->Value.err)
509 return memcmp(lpPropLeft->Value.lpguid, lpPropRight->Value.lpguid,
512 FIXME("Unhandled property type %ld", PROP_TYPE(lpPropLeft->ulPropTag));
516 /*************************************************************************
517 * HrGetOneProp@8 (MAPI32.135)
519 * Get a property value from an IMAPIProp object.
522 * lpIProp [I] IMAPIProp object to get the property value in
523 * ulPropTag [I] Property tag of the property to get
524 * lppProp [O] Destination for the returned property
527 * Success: S_OK. *lppProp contains the property value requested.
528 * Failure: MAPI_E_NOT_FOUND, if no property value has the tag given by ulPropTag.
530 HRESULT WINAPI HrGetOneProp(LPMAPIPROP lpIProp, ULONG ulPropTag, LPSPropValue *lppProp)
536 TRACE("(%p,%ld,%p)\n", lpIProp, ulPropTag, lppProp);
539 pta.aulPropTag[0] = ulPropTag;
540 hRet = IMAPIProp_GetProps(lpIProp, &pta, 0u, &ulCount, lppProp);
541 if (hRet == MAPI_W_ERRORS_RETURNED)
543 MAPIFreeBuffer(*lppProp);
545 hRet = MAPI_E_NOT_FOUND;
550 /*************************************************************************
551 * HrSetOneProp@8 (MAPI32.136)
553 * Set a property value in an IMAPIProp object.
556 * lpIProp [I] IMAPIProp object to set the property value in
557 * lpProp [I] Property value to set
560 * Success: S_OK. The value in lpProp is set in lpIProp.
561 * Failure: An error result from IMAPIProp_SetProps().
563 HRESULT WINAPI HrSetOneProp(LPMAPIPROP lpIProp, LPSPropValue lpProp)
565 TRACE("(%p,%p)\n", lpIProp, lpProp);
567 return IMAPIProp_SetProps(lpIProp, 1u, lpProp, NULL);
570 /*************************************************************************
571 * FPropExists@8 (MAPI32.137)
573 * Find a property with a given property tag in an IMAPIProp object.
576 * lpIProp [I] IMAPIProp object to find the property tag in
577 * ulPropTag [I] Property tag to find
580 * TRUE, if ulPropTag matches a property held in lpIProp,
584 * if ulPropTag has a property type of PT_UNSPECIFIED, then only the property
585 * Ids need to match for a successful match to occur.
587 BOOL WINAPI FPropExists(LPMAPIPROP lpIProp, ULONG ulPropTag)
591 TRACE("(%p,%ld)\n", lpIProp, ulPropTag);
595 LPSPropTagArray lpTags;
598 if (FAILED(IMAPIProp_GetPropList(lpIProp, 0u, &lpTags)))
601 for (i = 0; i < lpTags->cValues; i++)
603 if (!FBadPropTag(lpTags->aulPropTag[i]) &&
604 (lpTags->aulPropTag[i] == ulPropTag ||
605 (PROP_TYPE(ulPropTag) == PT_UNSPECIFIED &&
606 PROP_ID(lpTags->aulPropTag[i]) == lpTags->aulPropTag[i])))
612 MAPIFreeBuffer(lpTags);
617 /*************************************************************************
618 * PpropFindProp@12 (MAPI32.138)
620 * Find a property with a given property tag in a property array.
623 * lpProps [I] Property array to search
624 * cValues [I] Number of properties in lpProps
625 * ulPropTag [I] Property tag to find
628 * A pointer to the matching property, or NULL if none was found.
631 * if ulPropTag has a property type of PT_UNSPECIFIED, then only the property
632 * Ids need to match for a successful match to occur.
634 LPSPropValue WINAPI PpropFindProp(LPSPropValue lpProps, ULONG cValues, ULONG ulPropTag)
636 TRACE("(%p,%ld,%ld)\n", lpProps, cValues, ulPropTag);
638 if (lpProps && cValues)
641 for (i = 0; i < cValues; i++)
643 if (!FBadPropTag(lpProps[i].ulPropTag) &&
644 (lpProps[i].ulPropTag == ulPropTag ||
645 (PROP_TYPE(ulPropTag) == PT_UNSPECIFIED &&
646 PROP_ID(lpProps[i].ulPropTag) == PROP_ID(ulPropTag))))
653 /*************************************************************************
654 * FreePadrlist@4 (MAPI32.139)
656 * Free the memory used by an address book list.
659 * lpAddrs [I] Address book list to free
664 VOID WINAPI FreePadrlist(LPADRLIST lpAddrs)
666 TRACE("(%p)\n", lpAddrs);
668 /* Structures are binary compatible; use the same implementation */
669 return FreeProws((LPSRowSet)lpAddrs);
672 /*************************************************************************
673 * FreeProws@4 (MAPI32.140)
675 * Free the memory used by a row set.
678 * lpRowSet [I] Row set to free
683 VOID WINAPI FreeProws(LPSRowSet lpRowSet)
685 TRACE("(%p)\n", lpRowSet);
691 for (i = 0; i < lpRowSet->cRows; i++)
692 MAPIFreeBuffer(lpRowSet->aRow[i].lpProps);
694 MAPIFreeBuffer(lpRowSet);
698 /*************************************************************************
699 * ScCountProps@12 (MAPI32.170)
701 * Validate and determine the length of an array of properties.
704 * iCount [I] Length of the lpProps array
705 * lpProps [I] Array of properties to validate/size
706 * pcBytes [O] If non-NULL, destination for the size of the property array
709 * Success: S_OK. If pcBytes is non-NULL, it contains the size of the propery array.
710 * Failure: MAPI_E_INVALID_PARAMETER, if any parameter is invalid or validation
711 * of the property array fails.
713 SCODE WINAPI ScCountProps(INT iCount, LPSPropValue lpProps, ULONG *pcBytes)
715 ULONG i, ulCount = iCount, ulBytes = 0;
717 TRACE("(%d,%p,%p)\n", iCount, lpProps, pcBytes);
719 if (iCount <= 0 || !lpProps ||
720 IsBadReadPtr(lpProps, iCount * sizeof(SPropValue)))
721 return MAPI_E_INVALID_PARAMETER;
723 for (i = 0; i < ulCount; i++)
725 ULONG ulPropSize = 0;
727 if (FBadProp(&lpProps[i]) || lpProps[i].ulPropTag == PROP_ID_NULL ||
728 lpProps[i].ulPropTag == PROP_ID_INVALID)
729 return MAPI_E_INVALID_PARAMETER;
731 if (PROP_TYPE(lpProps[i].ulPropTag) != PT_OBJECT)
733 ulPropSize = UlPropSize(&lpProps[i]);
735 return MAPI_E_INVALID_PARAMETER;
738 switch (PROP_TYPE(lpProps[i].ulPropTag))
752 ulPropSize += sizeof(SPropValue);
755 ulPropSize += lpProps[i].Value.MVszA.cValues * sizeof(char*) + sizeof(SPropValue);
759 ulPropSize += lpProps[i].Value.MVszA.cValues * sizeof(char*) + sizeof(SPropValue);
762 ulPropSize += lpProps[i].Value.MVbin.cValues * sizeof(SBinary) + sizeof(SPropValue);
765 ulPropSize = sizeof(SPropValue);
768 ulBytes += ulPropSize;
776 /*************************************************************************
777 * ScCopyProps@16 (MAPI32.171)
779 * Copy an array of property values into a buffer suited for serialisation.
782 * cValues [I] Number of properties in lpProps
783 * lpProps [I] Property array to copy
784 * lpDst [O] Destination for the serialised data
785 * lpCount [O] If non-NULL, destination for the number of bytes of data written to lpDst
788 * Success: S_OK. lpDst contains the serialised data from lpProps.
789 * Failure: MAPI_E_INVALID_PARAMETER, if any parameter is invalid.
792 * The resulting property value array is stored in a contigous block starting at lpDst.
794 SCODE WINAPI ScCopyProps(int cValues, LPSPropValue lpProps, LPVOID lpDst, ULONG *lpCount)
796 LPSPropValue lpDest = (LPSPropValue)lpDst;
797 char *lpDataDest = (char *)(lpDest + cValues);
798 ULONG ulLen, i, iter;
800 TRACE("(%d,%p,%p,%p)\n", cValues, lpProps, lpDst, lpCount);
802 if (!lpProps || cValues < 0 || !lpDest)
803 return MAPI_E_INVALID_PARAMETER;
805 memcpy(lpDst, lpProps, cValues * sizeof(SPropValue));
807 for (iter = 0; iter < cValues; iter++)
809 switch (PROP_TYPE(lpProps->ulPropTag))
812 lpDest->Value.lpguid = (LPGUID)lpDataDest;
813 memcpy(lpDest->Value.lpguid, lpProps->Value.lpguid, sizeof(GUID));
814 lpDataDest += sizeof(GUID);
817 ulLen = lstrlenA(lpProps->Value.lpszA) + 1u;
818 lpDest->Value.lpszA = lpDataDest;
819 memcpy(lpDest->Value.lpszA, lpProps->Value.lpszA, ulLen);
823 ulLen = (strlenW(lpProps->Value.lpszW) + 1u) * sizeof(WCHAR);
824 lpDest->Value.lpszW = (LPWSTR)lpDataDest;
825 memcpy(lpDest->Value.lpszW, lpProps->Value.lpszW, ulLen);
829 lpDest->Value.bin.lpb = (LPBYTE)lpDataDest;
830 memcpy(lpDest->Value.bin.lpb, lpProps->Value.bin.lpb, lpProps->Value.bin.cb);
831 lpDataDest += lpProps->Value.bin.cb;
834 if (lpProps->ulPropTag & MV_FLAG)
836 lpDest->Value.MVi.cValues = lpProps->Value.MVi.cValues;
837 /* Note: Assignment uses lppszA but covers all cases by union aliasing */
838 lpDest->Value.MVszA.lppszA = (char**)lpDataDest;
840 switch (PROP_TYPE(lpProps->ulPropTag))
844 lpDataDest += lpProps->Value.MVszA.cValues * sizeof(char *);
846 for (i = 0; i < lpProps->Value.MVszA.cValues; i++)
848 ULONG ulStrLen = lstrlenA(lpProps->Value.MVszA.lppszA[i]) + 1u;
850 lpDest->Value.MVszA.lppszA[i] = lpDataDest;
851 memcpy(lpDataDest, lpProps->Value.MVszA.lppszA[i], ulStrLen);
852 lpDataDest += ulStrLen;
858 lpDataDest += lpProps->Value.MVszW.cValues * sizeof(WCHAR *);
860 for (i = 0; i < lpProps->Value.MVszW.cValues; i++)
862 ULONG ulStrLen = (strlenW(lpProps->Value.MVszW.lppszW[i]) + 1u) * sizeof(WCHAR);
864 lpDest->Value.MVszW.lppszW[i] = (LPWSTR)lpDataDest;
865 memcpy(lpDataDest, lpProps->Value.MVszW.lppszW[i], ulStrLen);
866 lpDataDest += ulStrLen;
872 lpDataDest += lpProps->Value.MVszW.cValues * sizeof(SBinary);
874 for (i = 0; i < lpProps->Value.MVszW.cValues; i++)
876 lpDest->Value.MVbin.lpbin[i].cb = lpProps->Value.MVbin.lpbin[i].cb;
877 lpDest->Value.MVbin.lpbin[i].lpb = (LPBYTE)lpDataDest;
878 memcpy(lpDataDest, lpProps->Value.MVbin.lpbin[i].lpb, lpDest->Value.MVbin.lpbin[i].cb);
879 lpDataDest += lpDest->Value.MVbin.lpbin[i].cb;
884 /* No embedded pointers, just copy the data over */
885 ulLen = UlPropSize(lpProps);
886 memcpy(lpDest->Value.MVi.lpi, lpProps->Value.MVi.lpi, ulLen);
897 *lpCount = lpDataDest - (char *)lpDst;
902 /*************************************************************************
903 * ScRelocProps@20 (MAPI32.172)
905 * Relocate the pointers in an array of property values after it has been copied.
908 * cValues [I] Number of properties in lpProps
909 * lpProps [O] Property array to relocate the pointers in.
910 * lpOld [I] Position where the data was copied from
911 * lpNew [I] Position where the data was copied to
912 * lpCount [O] If non-NULL, destination for the number of bytes of data at lpDst
915 * Success: S_OK. Any pointers in lpProps are relocated.
916 * Failure: MAPI_E_INVALID_PARAMETER, if any parameter is invalid.
919 * MSDN states that this function can be used for serialisation by passing
920 * NULL as either lpOld or lpNew, thus converting any pointers in lpProps
921 * between offsets and pointers. This does not work in native (it crashes),
922 * and cannot be made to work in Wine because the original interface design
923 * is deficient. The only use left for this function is to remap pointers
924 * in a contigous property array that has been copied with memcpy() to another
927 SCODE WINAPI ScRelocProps(int cValues, LPSPropValue lpProps, LPVOID lpOld,
928 LPVOID lpNew, ULONG *lpCount)
930 static const BOOL bBadPtr = TRUE; /* Windows bug - Assumes source is bad */
931 LPSPropValue lpDest = (LPSPropValue)lpProps;
932 ULONG ulCount = cValues * sizeof(SPropValue);
933 ULONG ulLen, i, iter;
935 TRACE("(%d,%p,%p,%p,%p)\n", cValues, lpProps, lpOld, lpNew, lpCount);
937 if (!lpProps || cValues < 0 || !lpOld || !lpNew)
938 return MAPI_E_INVALID_PARAMETER;
940 /* The reason native doesn't work as MSDN states is that it assumes that
941 * the lpProps pointer contains valid pointers. This is obviously not
942 * true if the array is being read back from serialisation (the pointers
943 * are just offsets). Native can't actually work converting the pointers to
944 * offsets either, because it converts any array pointers to offsets then
945 * _dereferences the offset_ in order to convert the array elements!
947 * The code below would handle both cases except that the design of this
948 * function makes it impossible to know when the pointers in lpProps are
949 * valid. If both lpOld and lpNew are non-NULL, native reads the pointers
950 * after converting them, so we must do the same. Its seems this
951 * functionality was never tested by MS.
954 #define RELOC_PTR(p) (((char*)(p)) - (char*)lpOld + (char*)lpNew)
956 for (iter = 0; iter < cValues; iter++)
958 switch (PROP_TYPE(lpDest->ulPropTag))
961 lpDest->Value.lpguid = (LPGUID)RELOC_PTR(lpDest->Value.lpguid);
962 ulCount += sizeof(GUID);
965 ulLen = bBadPtr ? 0 : lstrlenA(lpDest->Value.lpszA) + 1u;
966 lpDest->Value.lpszA = (LPSTR)RELOC_PTR(lpDest->Value.lpszA);
968 ulLen = lstrlenA(lpDest->Value.lpszA) + 1u;
972 ulLen = bBadPtr ? 0 : (lstrlenW(lpDest->Value.lpszW) + 1u) * sizeof(WCHAR);
973 lpDest->Value.lpszW = (LPWSTR)RELOC_PTR(lpDest->Value.lpszW);
975 ulLen = (strlenW(lpDest->Value.lpszW) + 1u) * sizeof(WCHAR);
979 lpDest->Value.bin.lpb = (LPBYTE)RELOC_PTR(lpDest->Value.bin.lpb);
980 ulCount += lpDest->Value.bin.cb;
983 if (lpDest->ulPropTag & MV_FLAG)
985 /* Since we have to access the array elements, don't map the
986 * array unless it is invalid (otherwise, map it at the end)
989 lpDest->Value.MVszA.lppszA = (LPSTR*)RELOC_PTR(lpDest->Value.MVszA.lppszA);
991 switch (PROP_TYPE(lpProps->ulPropTag))
995 ulCount += lpDest->Value.MVszA.cValues * sizeof(char *);
997 for (i = 0; i < lpDest->Value.MVszA.cValues; i++)
999 ULONG ulStrLen = bBadPtr ? 0 : lstrlenA(lpDest->Value.MVszA.lppszA[i]) + 1u;
1001 lpDest->Value.MVszA.lppszA[i] = (LPSTR)RELOC_PTR(lpDest->Value.MVszA.lppszA[i]);
1003 ulStrLen = lstrlenA(lpDest->Value.MVszA.lppszA[i]) + 1u;
1004 ulCount += ulStrLen;
1010 ulCount += lpDest->Value.MVszW.cValues * sizeof(WCHAR *);
1012 for (i = 0; i < lpDest->Value.MVszW.cValues; i++)
1014 ULONG ulStrLen = bBadPtr ? 0 : (strlenW(lpDest->Value.MVszW.lppszW[i]) + 1u) * sizeof(WCHAR);
1016 lpDest->Value.MVszW.lppszW[i] = (LPWSTR)RELOC_PTR(lpDest->Value.MVszW.lppszW[i]);
1018 ulStrLen = (strlenW(lpDest->Value.MVszW.lppszW[i]) + 1u) * sizeof(WCHAR);
1019 ulCount += ulStrLen;
1025 ulCount += lpDest->Value.MVszW.cValues * sizeof(SBinary);
1027 for (i = 0; i < lpDest->Value.MVszW.cValues; i++)
1029 lpDest->Value.MVbin.lpbin[i].lpb = (LPBYTE)RELOC_PTR(lpDest->Value.MVbin.lpbin[i].lpb);
1030 ulCount += lpDest->Value.MVbin.lpbin[i].cb;
1035 ulCount += UlPropSize(lpDest);
1039 lpDest->Value.MVszA.lppszA = (LPSTR*)RELOC_PTR(lpDest->Value.MVszA.lppszA);
1051 /*************************************************************************
1052 * LpValFindProp@12 (MAPI32.173)
1054 * Find a property with a given property id in a property array.
1057 * ulPropTag [I] Property tag containing property id to find
1058 * cValues [I] Number of properties in lpProps
1059 * lpProps [I] Property array to search
1062 * A pointer to the matching property, or NULL if none was found.
1065 * This function matches only on the property id and does not care if the
1066 * property types differ.
1068 LPSPropValue WINAPI LpValFindProp(ULONG ulPropTag, ULONG cValues, LPSPropValue lpProps)
1070 TRACE("(%ld,%ld,%p)\n", ulPropTag, cValues, lpProps);
1072 if (lpProps && cValues)
1075 for (i = 0; i < cValues; i++)
1077 if (PROP_ID(ulPropTag) == PROP_ID(lpProps[i].ulPropTag))
1084 /*************************************************************************
1085 * ScDupPropset@16 (MAPI32.174)
1087 * Duplicate a property value array into a contigous block of memory.
1090 * cValues [I] Number of properties in lpProps
1091 * lpProps [I] Property array to duplicate
1092 * lpAlloc [I] Memory allocation function, use MAPIAllocateBuffer()
1093 * lpNewProp [O] Destination for the newly duplicated property value array
1096 * Success: S_OK. *lpNewProp contains the duplicated array.
1097 * Failure: MAPI_E_INVALID_PARAMETER, if any parameter is invalid,
1098 * MAPI_E_NOT_ENOUGH_MEMORY, if memory allocation fails.
1100 SCODE WINAPI ScDupPropset(int cValues, LPSPropValue lpProps,
1101 LPALLOCATEBUFFER lpAlloc, LPSPropValue *lpNewProp)
1106 TRACE("(%d,%p,%p,%p)\n", cValues, lpProps, lpAlloc, lpNewProp);
1108 sc = ScCountProps(cValues, lpProps, &ulCount);
1111 sc = lpAlloc(ulCount, (LPVOID*)lpNewProp);
1113 sc = ScCopyProps(cValues, lpProps, *lpNewProp, &ulCount);
1118 /*************************************************************************
1119 * FBadRglpszA@8 (MAPI32.175)
1121 * Determine if an array of strings is invalid
1124 * lppszStrs [I] Array of strings to check
1125 * ulCount [I] Number of strings in lppszStrs
1128 * TRUE, if lppszStrs is invalid, FALSE otherwise.
1130 BOOL WINAPI FBadRglpszA(LPSTR *lppszStrs, ULONG ulCount)
1134 TRACE("(%p,%ld)\n", lppszStrs, ulCount);
1139 if (!lppszStrs || IsBadReadPtr(lppszStrs, ulCount * sizeof(LPWSTR)))
1142 for (i = 0; i < ulCount; i++)
1144 if (!lppszStrs[i] || IsBadStringPtrA(lppszStrs[i], -1))
1150 /*************************************************************************
1151 * FBadRglpszW@8 (MAPI32.176)
1155 BOOL WINAPI FBadRglpszW(LPWSTR *lppszStrs, ULONG ulCount)
1159 TRACE("(%p,%ld)\n", lppszStrs, ulCount);
1164 if (!lppszStrs || IsBadReadPtr(lppszStrs, ulCount * sizeof(LPWSTR)))
1167 for (i = 0; i < ulCount; i++)
1169 if (!lppszStrs[i] || IsBadStringPtrW(lppszStrs[i], -1))
1175 /*************************************************************************
1176 * FBadRowSet@4 (MAPI32.177)
1178 * Determine if a row is invalid
1181 * lpRow [I] Row to check
1184 * TRUE, if lpRow is invalid, FALSE otherwise.
1186 BOOL WINAPI FBadRowSet(LPSRowSet lpRowSet)
1189 TRACE("(%p)\n", lpRowSet);
1191 if (!lpRowSet || IsBadReadPtr(lpRowSet, CbSRowSet(lpRowSet)))
1194 for (i = 0; i < lpRowSet->cRows; i++)
1196 if (FBadRow(&lpRowSet->aRow[i]))
1202 /*************************************************************************
1203 * FBadPropTag@4 (MAPI32.179)
1205 * Determine if a property tag is invalid
1208 * ulPropTag [I] Property tag to check
1211 * TRUE, if ulPropTag is invalid, FALSE otherwise.
1213 ULONG WINAPI FBadPropTag(ULONG ulPropTag)
1215 TRACE("(0x%08lx)\n", ulPropTag);
1217 switch (ulPropTag & (~MV_FLAG & PROP_TYPE_MASK))
1219 case PT_UNSPECIFIED:
1241 /*************************************************************************
1242 * FBadRow@4 (MAPI32.180)
1244 * Determine if a row is invalid
1247 * lpRow [I] Row to check
1250 * TRUE, if lpRow is invalid, FALSE otherwise.
1252 ULONG WINAPI FBadRow(LPSRow lpRow)
1255 TRACE("(%p)\n", lpRow);
1257 if (!lpRow || IsBadReadPtr(lpRow, sizeof(SRow)) || !lpRow->lpProps ||
1258 IsBadReadPtr(lpRow->lpProps, lpRow->cValues * sizeof(SPropValue)))
1261 for (i = 0; i < lpRow->cValues; i++)
1263 if (FBadProp(&lpRow->lpProps[i]))
1269 /*************************************************************************
1270 * FBadProp@4 (MAPI32.181)
1272 * Determine if a property is invalid
1275 * lpProp [I] Property to check
1278 * TRUE, if lpProp is invalid, FALSE otherwise.
1280 ULONG WINAPI FBadProp(LPSPropValue lpProp)
1284 if (!lpProp || IsBadReadPtr(lpProp, sizeof(SPropValue)) ||
1285 FBadPropTag(lpProp->ulPropTag))
1288 switch (PROP_TYPE(lpProp->ulPropTag))
1290 /* Single value properties containing pointers */
1292 if (!lpProp->Value.lpszA || IsBadStringPtrA(lpProp->Value.lpszA, -1))
1296 if (!lpProp->Value.lpszW || IsBadStringPtrW(lpProp->Value.lpszW, -1))
1300 if (IsBadReadPtr(lpProp->Value.bin.lpb, lpProp->Value.bin.cb))
1304 if (IsBadReadPtr(lpProp->Value.lpguid, sizeof(GUID)))
1308 /* Multiple value properties (arrays) containing no pointers */
1310 return PROP_BadArray(lpProp, sizeof(SHORT));
1312 return PROP_BadArray(lpProp, sizeof(LONG));
1313 case PT_MV_LONGLONG:
1314 return PROP_BadArray(lpProp, sizeof(LONG64));
1316 return PROP_BadArray(lpProp, sizeof(float));
1318 return PROP_BadArray(lpProp, sizeof(FILETIME));
1321 return PROP_BadArray(lpProp, sizeof(double));
1322 case PT_MV_CURRENCY:
1323 return PROP_BadArray(lpProp, sizeof(CY));
1325 return PROP_BadArray(lpProp, sizeof(GUID));
1327 /* Multiple value properties containing pointers */
1329 return FBadRglpszA(lpProp->Value.MVszA.lppszA,
1330 lpProp->Value.MVszA.cValues);
1332 return FBadRglpszW(lpProp->Value.MVszW.lppszW,
1333 lpProp->Value.MVszW.cValues);
1335 if (PROP_BadArray(lpProp, sizeof(SBinary)))
1338 for (i = 0; i < lpProp->Value.MVszW.cValues; i++)
1340 if (IsBadReadPtr(lpProp->Value.MVbin.lpbin[i].lpb,
1341 lpProp->Value.MVbin.lpbin[i].cb))
1349 /*************************************************************************
1350 * FBadColumnSet@4 (MAPI32.182)
1352 * Determine if an array of property tags is invalid
1355 * lpCols [I] Property tag array to check
1358 * TRUE, if lpCols is invalid, FALSE otherwise.
1360 ULONG WINAPI FBadColumnSet(LPSPropTagArray lpCols)
1362 ULONG ulRet = FALSE, i;
1364 TRACE("(%p)\n", lpCols);
1366 if (!lpCols || IsBadReadPtr(lpCols, CbSPropTagArray(lpCols)))
1370 for (i = 0; i < lpCols->cValues; i++)
1372 if ((lpCols->aulPropTag[i] & PROP_TYPE_MASK) == PT_ERROR ||
1373 FBadPropTag(lpCols->aulPropTag[i]))
1380 TRACE("Returning %s\n", ulRet ? "TRUE" : "FALSE");