ScCopyProps
Applies to: Outlook 2013 | Outlook 2016
Copies the properties defined by an array of SPropValue structures to a new destination.
| Property | Value |
|---|---|
| Header file: |
Mapiutil.h |
| Implemented by: |
MAPI |
| Called by: |
Client applications and service providers |
SCODE ScCopyProps(
int cprop,
LPSPropValue rgprop,
LPVOID pvDst,
ULONG FAR * pcb
);
Parameters
cprop
[in] Count of properties to be copied.
rgprop
[in] Pointer to an array of SPropValue structures that define the properties to be copied. The rgprop parameter does not have to point to the beginning of the array, but it must point to the beginning of one of the SPropValue structures in the array.
pvDst
[in] Pointer to the initial position in memory to which this function copies the properties.
pcb
[out] Optional pointer to the size, in bytes, of the block of memory pointed to by the pvDst parameter.
Return value
S_OK
Properties were copied successfully.
MAPI_E_INVALID_PARAMETER
An unknown property type was encountered.
Remarks
The new array and its data reside in a buffer created with a single allocation, and the ScRelocProps function can be used to adjust the pointers in the individual SPropValue structures. Prior to this adjustment, the pointers are valid.
ScCopyProps maintains the original property order for the copied property array.
The pcb parameter is optional; if it is not NULL, it is set to the number of bytes stored in the pvDst parameter.