ScCountProps
The ScCountProps
function determines the size, in bytes, of a property value array and validates
the memory associated with the array.
Note This function
may not be supported in future versions of MAPI.
Quick Info
Header
file: |
MAPIUTIL.H |
Implemented
by: |
MAPI |
Called by: |
Client
applications and service providers |
SCODE ScCountProps(
int cprop, |
|
LPSPropValue rgprop,
|
|
ULONG FAR * pcb |
|
); |
|
Parameters
cprop
[in] Count of
properties in the array indicated by the rgprop parameter.
rgprop
[in] Pointer
to a range in an array of SPropValue
pcb
[out]
Optional pointer to the size, in bytes, of the property array.
Return Values
S_OK
The call
succeeded and has returned the expected value or values.
MAPI_E_INVALID_PARAMETER
A property in
the property value array has an identifier of PROP_ID_NULL or PROP_ID_INVALID
or the property array contains a multivalued property with no property values.
Remarks
If NULL is
passed in the pcb parameter, the ScCountProps function validates
the array of notifications but no counting is done. If a non-null value is
passed in pcb, the ScCountNotifications function determines the
size of the array and stores the result in pcb. The pcb parameter
must be large enough to contain the entire array.
As it is
counting, ScCountProps validates the memory associated with the array. ScCountProps
only works with properties about which MAPI has information.
See Also
PropCopyMore