IDistList::GetProps method

Retrieves the property tag information for the distribution list items.

Syntax

HRESULT GetProps(
   SPropTagArray *lpPropTagArray,
   ULONG         ulFlags,
   ULONG         *lpcValues,
   SPropValue    **lppPropArray
);

Parameters

lpPropTagArray

Type: SPropTagArray*

Pointer to an SPropTagArray structure of properties whose values are to be retrieved. A NULL value specifies that all properties should be retrieved.

ulFlags

Type: ULONG

The following flag is required.

MAPI_UNICODE

Indicates that wide strings are to be retrieved.

lpcValues

Type: ULONG*

Pointer to a variable of type ULONG that retrieves the number of returned property values. The value of lpcValues is zero if lppPropArray is NULL.

lppPropArray

Type: SPropValue**

Address of a pointer to an SPropValue variable type that retrieves the SPropValue array. It must be freed by the caller.

Return value

Type: HRESULT

This method can return one of these values.

Return code	Description
S_OK	The property values were retrieved successfully.
MAPI_W_ERRORS_RETURNED	The call succeeded overall, but one or more properties could not be accessed. The ulPropTag member of the property value for each inaccessible property in the lppPropArray parameter has a property type of PT_ERROR and an identifier of zero. When this warning is returned, the call should be handled as successful. To test for this warning, use the FAILED macro.
MAPI_E_INVALID_PARAMETER	Zero was passed in the cValues member of the SPropTagArray structure to which lpPropTagArray points.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Product	Internet Explorer 4.0
Header	Wabtmp.h
DLL	Wab32.dll