SPropValue 

The SPropValue structure describes a MAPI property.

Quick Info

typedef struct _SPropValue

{ 

     ULONG     ulPropTag;

     ULONG     dwAlignPad;

     union _PV  Value;

} SPropValue, FAR *LPSPropValue;

Members

ulPropTag

Property tag for the property. Property tags are 32-bit unsigned integers consisting of the property s unique identifier in the high order 16 bits and the property s type in the low order 16 bits.

dwAlignPad

Reserved for MAPI; do not use.

Value

Union of data values, the specific value dictated by the type of property. Property types are stored in the ulPropTag member.

Remarks

The ulPropTag member is made up of two parts: an identifier and a type. The identifier is a numeric value that is assigned to a particular range. MAPI defines ranges for identifiers to describe the purpose of the property and who is responsible for maintaining it. The type is a value that indicates the format for the property s value. MAPI defines constants for each of the property types that it supports in the MAPIDEFS.H header file and each of the property tags it supports in the MAPITAGS.H header file.

For a complete list of the valid property ranges for identifiers and property types, see the Property Identifiers and Types18OKWU2 appendix.

The dwAlignPad member is designed for computers that require 8-byte alignment for 8-byte values. This member makes it possible for clients and service providers to allocate an array of property values on an 8-byte boundary and have the array aligned correctly. Developers who write code on such computers should use memory allocation routines that allocate the SPropValue arrays on 8-byte boundaries. The property type designates which member of the union should be used. The Value member contains one of the members of the _UPV union, defined as follows:

typedef union _PV

{ 

     short int             i;

     LONG                  l;

     ULONG                 ul;

     float                 flt;

     double                dbl;

     unsigned short int    b;

     CURRENCY              cur;

     double                at;

     FILETIME              ft;

     LPSTR                 lpszA;

     SBinary               bin;

     LPWSTR                lpszW;

     LPGUID                lpguid;

     LARGE_INTEGER         li;

     SShortArray           MVi;

     SLongArray            MVl;

     SRealArray            MVflt;

     SDoubleArray          MVdbl;

     SCurrencyArray        MVcur;

     SAppTimeArray         MVat;

     SDateTimeArray        MVft;

     SBinaryArray          MVbin;

     SLPSTRArray           MVszA;

     SWStringArray         MVszW;

     SGuidArray            MVguid;

     SLargeIntegerArray    MVli;

     SCODE                 err;

     LONG                  x;

} _UPV;

The members of the _UPV union contain the following values for single valued properties:

The following table lists the members of the _UPV union that describe multivalued properties:

The final two members of the _UPV union, err and x, describe property values with special types. The err member describes a property of type PT_ERROR and the x member a property of type PT_NULL or PT_OBJECT.