IReconcileInitiator::SetAbortCallback

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
-
Header File
reconcil.h
Unicode
No
Platform Notes
None

[Now Supported on Windows NT]

Sets the object through which the initiator can asynchronously terminate a reconciliation. A briefcase reconciler typically sets this object for reconciliations that are lengthy or involve user interaction.

The initiator can accept or reject the object. If the initiator accepts the object, the briefcase reconciler must later remove the object by subsequently calling this function with a NULL parameter when the reconciliation is complete. Because the reconciler removes the object after completing reconciliation, there may be times when the initiator releases the object after reconciliation is complete. In such cases, the reconciler ignores the request to terminate.

If the reconciliation is terminated, the IReconcilableObject::Reconcile member function must return either the REC_E_ABORTED or REC_E_NOTCOMPLETE value.

HRESULT IReconcileInitiator::SetAbortCallback(

IUnknown *pUnkForAbort
);

Parameteres
pUnkForAbort

Address of the IUnknown interface for the object. The initiator signals a request to terminate the reconciliation by using the IUnknown::Release member function to release the object. This parameter may be NULL to direct the initiator to remove the previously specified object.

Return Values
Returns the S_OK value if successful. Otherwise, the member function returns one of the following error values:

REC_E_NOCALLBACK	The initiator does not support termination of reconciliation operations and does not hold the specified object.
E_UNEXPECTED	Unspecified error.