| Platform SDK: MAPI |
The IMAPIProp::CopyProps method copies or moves selected properties.
See IMAPIProp : IUnknown.
HRESULT CopyProps( LPSPropTagArray lpIncludeProps, ULONG ulUIParam, LPMAPIPROGRESS lpProgress, LPCIID lpInterface, LPVOID lpDestObj, ULONG ulFlags, LPSPropProblemArray FAR * lppProblems );
The following values can be returned in the SPropProblemArray structure, but not as return values for CopyProps. These errors apply to a single property:
The IMAPIProp::CopyProps method copies or moves selected properties from the current object to a destination object. CopyProps is used mainly for replying to and forwarding messages, where only some of the properties from the original message travel with the reply or forwarded copy.
Any subobjects in the source object are automatically included in the operation and copied or moved in their entirety, regardless of the use of properties indicated by the SPropTagArray structure. By default, CopyProps overwrites any properties in the destination object that match properties from the source object. If any of the copied or moved properties already exist in the destination object, the existing properties are overwritten by the new, unless the MAPI_NOREPLACE flag is set in the ulFlags parameter. Existing information in the destination object that is not overwritten is left untouched.
You can provide a full implementation of CopyProps or rely on the implementation that MAPI provides in its support object. If you want to use the MAPI implementation, call IMAPISupport::DoCopyProps. However, If you do delegate processing to DoCopyProps and you are passed the MAPI_DECLINE_OK flag, avoid the support call and return MAPI_E_DECLINE_COPY instead. You will be called with this flag by MAPI to avoid the possible recursion that can happen when copying folders.
Because the copy operation can be lengthy, you are encouraged to display a progress indicator. Use the IMAPIProgress implementation passed in the lpProgress parameter, if there is one. If lpProgress is NULL, call IMAPISupport::DoProgressDialog to use the MAPI implementation.
Do not set the MAPI_DECLINE_OK flag; it is used by MAPI in its calls to message store provider CopyProps implementations.
Because copy and move operations can take time, it is wise to request the display of a progress indicator by setting the MAPI_DIALOG flag. You can set the lpProgress parameter to your implementation of IMAPIProgress, if you have one, or to NULL. If lpProgress is NULL, CopyProps will use the default progress indicator provided by MAPI.
You can suppress the display of a progress indicator by not setting the MAPI_DIALOG flag. CopyProps will ignore the ulUIParam and lpProgress parameters and avoid displaying the indicator.
CopyProps can report global and individual errors, or errors that occur with one or more of the properties. These individual errors are placed in an SPropProblemArray structure. You can suppress error reporting at the property level by passing NULL for the property problem array structure parameter rather than a valid pointer.
If you want to receive information about errors, pass a valid SPropProblemArray structure pointer in the lppProblems parameter. When CopyProps returns S_OK, check for possible errors with individual properties in the structure. When CopyProps returns an error, no information is returned in the SPropProblemArray structure. Instead, call IMAPIProp::GetLastError to retrieve detailed error information.
If CopyProps returns S_OK, free the returned SPropProblemArray structure by calling the MAPIFreeBuffer function.
If you are copying properties that are unique to the source object type, you must be sure that the destination object is of the same type. CopyProps does not prevent you from associating properties that typically belong to one type of object with another type of object. It is up to you to copy properties that make sense for the destination object. For example, you should not copy message properties to an address book container.
To ensure that you are copying between objects of the same type, check that the source and destination object are the same type, either by comparing object pointers or calling IUnknown::QueryInterface. Set the interface identifier pointed to by lpInterface to the standard interface for the source object. Also, make sure that the object type — or PR_OBJECT_TYPE property — is the same for the two objects. For example, if you are copying from a message, set lpInterface to IID_IMessage and the PR_OBJECT_TYPE for both objects to MAPI_MESSAGE.
If an invalid pointer is passed in the lpDestObj parameter, the results are unpredictable.
To copy a message's recipient list, call the message's IMAPIProp::CopyProps method and include the PR_MESSAGE_RECIPIENTS property in the property tag array. To copy the message's attachments, include the PR_MESSAGE_ATTACHMENTS property.
To copy a folder or address book container's hierarchy or contents table, include PR_CONTAINER_HIERARCHY or PR_CONTAINER_CONTENTS in the property tag array. To include a folder's associated contents table, include the PR_FOLDER_ASSOCIATED_CONTENTS property in the array.
IMAPIFolder::CopyMessages, IMAPIProp::CopyTo, IMAPIProp::GetLastError, SPropProblemArray, SPropTagArray