include/propvarutil.h

   1 /*
   2  * Copyright 2008 James Hawkins for CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifndef __WINE_PROPVARUTIL_H
  20 #define __WINE_PROPVARUTIL_H
  21
  22 #include <shtypes.h>
  23 #include <shlwapi.h>
  24
  25 #ifndef WINE_NTSTATUS_DECLARED
  26 #define WINE_NTSTATUS_DECLARED
  27 typedef LONG NTSTATUS;
  28 #endif
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 enum tagPROPVAR_CHANGE_FLAGS
  35 {
  36     PVCHF_DEFAULT           = 0x00000000,
  37     PVCHF_NOVALUEPROP       = 0x00000001,
  38     PVCHF_ALPHABOOL         = 0x00000002,
  39     PVCHF_NOUSEROVERRIDE    = 0x00000004,
  40     PVCHF_LOCALBOOL         = 0x00000008,
  41     PVCHF_NOHEXSTRING       = 0x00000010,
  42 };
  43
  44 typedef int PROPVAR_CHANGE_FLAGS;
  45
  46 enum tagPROPVAR_COMPARE_UNIT
  47 {
  48     PVCU_DEFAULT           = 0x00000000,
  49     PVCU_SECOND            = 0x00000001,
  50     PVCU_MINUTE            = 0x00000002,
  51     PVCU_HOUR              = 0x00000003,
  52     PVCU_DAY               = 0x00000004,
  53     PVCU_MONTH             = 0x00000005,
  54     PVCU_YEAR              = 0x00000006,
  55 };
  56
  57 typedef int PROPVAR_COMPARE_UNIT;
  58
  59 enum tagPROPVAR_COMPARE_FLAGS
  60 {
  61     PVCF_DEFAULT           = 0x00000000,
  62     PVCF_TREATEMPTYASGREATERTHAN = 0x00000001,
  63     PVCF_USESTRCMP         = 0x00000002,
  64     PVCF_USESTRCMPC        = 0x00000004,
  65     PVCF_USESTRCMPI        = 0x00000008,
  66     PVCF_USESTRCMPIC       = 0x00000010,
  67 };
  68
  69 typedef int PROPVAR_COMPARE_FLAGS;
  70
  71 HRESULT WINAPI PropVariantChangeType(PROPVARIANT *ppropvarDest, REFPROPVARIANT propvarSrc,
  72                                      PROPVAR_CHANGE_FLAGS flags, VARTYPE vt);
  73 HRESULT WINAPI InitPropVariantFromGUIDAsString(REFGUID guid, PROPVARIANT *ppropvar);
  74 HRESULT WINAPI InitVariantFromFileTime(const FILETIME *ft, VARIANT *var);
  75 HRESULT WINAPI InitVariantFromGUIDAsString(REFGUID guid, VARIANT *pvar);
  76 HRESULT WINAPI InitPropVariantFromBuffer(const VOID *pv, UINT cb, PROPVARIANT *ppropvar);
  77 HRESULT WINAPI InitPropVariantFromCLSID(REFCLSID clsid, PROPVARIANT *ppropvar);
  78 HRESULT WINAPI InitVariantFromBuffer(const VOID *pv, UINT cb, VARIANT *pvar);
  79 HRESULT WINAPI PropVariantToGUID(const PROPVARIANT *ppropvar, GUID *guid);
  80 HRESULT WINAPI VariantToGUID(const VARIANT *pvar, GUID *guid);
  81 INT WINAPI PropVariantCompareEx(REFPROPVARIANT propvar1, REFPROPVARIANT propvar2,
  82                                 PROPVAR_COMPARE_UNIT uint, PROPVAR_COMPARE_FLAGS flags);
  83 HRESULT WINAPI InitPropVariantFromFileTime(const FILETIME *pftIn, PROPVARIANT *ppropvar);
  84 HRESULT WINAPI InitPropVariantFromStringVector(PCWSTR *strs, ULONG count, PROPVARIANT *ppropvar);
  85
  86 HRESULT WINAPI PropVariantToDouble(REFPROPVARIANT propvarIn, double *ret);
  87 HRESULT WINAPI PropVariantToInt16(REFPROPVARIANT propvarIn, SHORT *ret);
  88 HRESULT WINAPI PropVariantToInt32(REFPROPVARIANT propvarIn, LONG *ret);
  89 HRESULT WINAPI PropVariantToInt64(REFPROPVARIANT propvarIn, LONGLONG *ret);
  90 HRESULT WINAPI PropVariantToUInt16(REFPROPVARIANT propvarIn, USHORT *ret);
  91 HRESULT WINAPI PropVariantToUInt32(REFPROPVARIANT propvarIn, ULONG *ret);
  92 ULONG WINAPI PropVariantToUInt32WithDefault(REFPROPVARIANT propvarIn, ULONG uLDefault);
  93 HRESULT WINAPI PropVariantToUInt64(REFPROPVARIANT propvarIn, ULONGLONG *ret);
  94 HRESULT WINAPI PropVariantToBoolean(REFPROPVARIANT propvarIn, BOOL *ret);
  95 HRESULT WINAPI PropVariantToBuffer(REFPROPVARIANT propvarIn, void *ret, UINT cb);
  96 HRESULT WINAPI PropVariantToString(REFPROPVARIANT propvarIn, PWSTR ret, UINT cch);
  97 PCWSTR WINAPI PropVariantToStringWithDefault(REFPROPVARIANT propvarIn, LPCWSTR pszDefault);
  98 PCWSTR WINAPI VariantToStringWithDefault(const VARIANT *pvar, LPCWSTR pszDefault);
  99 HRESULT WINAPI VariantToString(REFVARIANT var, PWSTR ret, UINT cch);
 100
 101 HRESULT WINAPI PropVariantToStringAlloc(REFPROPVARIANT propvarIn, WCHAR **ret);
 102
 103 #ifdef __cplusplus
 104
 105 HRESULT InitPropVariantFromBoolean(BOOL fVal, PROPVARIANT *ppropvar);
 106 HRESULT InitPropVariantFromInt16(SHORT nVal, PROPVARIANT *ppropvar);
 107 HRESULT InitPropVariantFromUInt16(USHORT uiVal, PROPVARIANT *ppropvar);
 108 HRESULT InitPropVariantFromInt32(LONG lVal, PROPVARIANT *ppropvar);
 109 HRESULT InitPropVariantFromUInt32(ULONG ulVal, PROPVARIANT *ppropvar);
 110 HRESULT InitPropVariantFromInt64(LONGLONG llVal, PROPVARIANT *ppropvar);
 111 HRESULT InitPropVariantFromUInt64(ULONGLONG ullVal, PROPVARIANT *ppropvar);
 112 HRESULT InitPropVariantFromDouble(DOUBLE dblVal, PROPVARIANT *ppropvar);
 113 HRESULT InitPropVariantFromString(PCWSTR psz, PROPVARIANT *ppropvar);
 114 HRESULT InitPropVariantFromGUIDAsBuffer(REFGUID guid, PROPVARIANT *ppropvar);
 115 BOOL IsPropVariantVector(REFPROPVARIANT propvar);
 116 BOOL IsPropVariantString(REFPROPVARIANT propvar);
 117
 118 #ifndef NO_PROPVAR_INLINES
 119
 120 inline HRESULT InitPropVariantFromBoolean(BOOL fVal, PROPVARIANT *ppropvar)
 121 {
 122     ppropvar->vt = VT_BOOL;
 123     ppropvar->boolVal = fVal ? VARIANT_TRUE : VARIANT_FALSE;
 124     return S_OK;
 125 }
 126
 127 inline HRESULT InitPropVariantFromInt16(SHORT nVal, PROPVARIANT *ppropvar)
 128 {
 129     ppropvar->vt = VT_I2;
 130     ppropvar->iVal = nVal;
 131     return S_OK;
 132 }
 133
 134 inline HRESULT InitPropVariantFromUInt16(USHORT uiVal, PROPVARIANT *ppropvar)
 135 {
 136     ppropvar->vt = VT_UI2;
 137     ppropvar->uiVal = uiVal;
 138     return S_OK;
 139 }
 140
 141 inline HRESULT InitPropVariantFromInt32(LONG lVal, PROPVARIANT *ppropvar)
 142 {
 143     ppropvar->vt = VT_I4;
 144     ppropvar->lVal = lVal;
 145     return S_OK;
 146 }
 147
 148 inline HRESULT InitPropVariantFromUInt32(ULONG ulVal, PROPVARIANT *ppropvar)
 149 {
 150     ppropvar->vt = VT_UI4;
 151     ppropvar->ulVal = ulVal;
 152     return S_OK;
 153 }
 154
 155 inline HRESULT InitPropVariantFromInt64(LONGLONG llVal, PROPVARIANT *ppropvar)
 156 {
 157     ppropvar->vt = VT_I8;
 158     ppropvar->hVal.QuadPart = llVal;
 159     return S_OK;
 160 }
 161
 162 inline HRESULT InitPropVariantFromUInt64(ULONGLONG ullVal, PROPVARIANT *ppropvar)
 163 {
 164     ppropvar->vt = VT_UI8;
 165     ppropvar->uhVal.QuadPart = ullVal;
 166     return S_OK;
 167 }
 168
 169 inline HRESULT InitPropVariantFromDouble(DOUBLE dblVal, PROPVARIANT *ppropvar)
 170 {
 171     ppropvar->vt = VT_R8;
 172     ppropvar->dblVal = dblVal;
 173     return S_OK;
 174 }
 175
 176 inline HRESULT InitPropVariantFromString(PCWSTR psz, PROPVARIANT *ppropvar)
 177 {
 178     HRESULT hres;
 179
 180     hres = SHStrDupW(psz, &ppropvar->pwszVal);
 181     if(SUCCEEDED(hres))
 182         ppropvar->vt = VT_LPWSTR;
 183     else
 184         PropVariantInit(ppropvar);
 185
 186     return hres;
 187 }
 188
 189 inline HRESULT InitPropVariantFromGUIDAsBuffer(REFGUID guid, PROPVARIANT *ppropvar)
 190 {
 191 #ifdef __cplusplus
 192     return InitPropVariantFromBuffer(&guid, sizeof(GUID), ppropvar);
 193 #else
 194     return InitPropVariantFromBuffer(guid, sizeof(GUID), ppropvar);
 195 #endif
 196 }
 197
 198 inline BOOL IsPropVariantVector(REFPROPVARIANT propvar)
 199 {
 200     return (propvar.vt & (VT_ARRAY | VT_VECTOR));
 201 }
 202
 203 inline BOOL IsPropVariantString(REFPROPVARIANT propvar)
 204 {
 205     return (PropVariantToStringWithDefault(propvar, NULL) != NULL);
 206 }
 207
 208 #endif /* NO_PROPVAR_INLINES */
 209 #endif /* __cplusplus */
 210
 211 HRESULT WINAPI StgSerializePropVariant(const PROPVARIANT *ppropvar, SERIALIZEDPROPERTYVALUE **ppprop, ULONG *pcb);
 212 HRESULT WINAPI StgDeserializePropVariant(const SERIALIZEDPROPERTYVALUE *pprop, ULONG cbmax, PROPVARIANT *ppropvar);
 213
 214 #ifdef __cplusplus
 215 }
 216 #endif
 217
 218 #endif /* __WINE_PROPVARUTIL_H */