Share via

3.2.4.1.8 UpdateCancel (Opnum 7)

  • Article

The UpdateCancel method is used by a client to indicate to a server that it could not process an update.

 DWORD UpdateCancel(
   [in] FRS_CONNECTION_ID connectionId,
   [in] FRS_UPDATE_CANCEL_DATA cancelData
 );

connectionId: The GUID of the connection ID that represents a specific replication partnership.

cancelData: The FRS_UPDATE_CANCEL_DATA structure that describes an update to cancel.

Return Values: This method MUST return 0 on success or a nonzero error code on failure. For protocol purposes all nonzero values MUST be treated as equivalent failures unless otherwise specified.

Return value/code

Description

0x00000000

ERROR_SUCCESS

The method completed successfully.

0x00002344

FRS_ERROR_CONTENTSET_NOT_FOUND

The content set was not found.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].

Validating the update cancel request: The server MUST validate the update cancel request by performing the following checks.

  • If an outbound connection for the specified connection is not established between the client and server (see the EstablishConnection method) then the server MUST fail the call with an implementation-defined failure value.

  • If a replicated folder session for the replicated folder specified by contentSetId field of the cancelData parameter is not established between the client and server (see the EstablishSession method) then the server MUST fail the call with the FRS_ERROR_CONTENTSET_NOT_FOUND failure value.

  • If the input parameter cancelData is not valid (see section 2.2.1.4.5 for a definition of a valid FRS_UPDATE_CANCEL_DATA structure), then the server MUST fail the call with an implementation-defined failure value.

Actions Triggered: The server MUST record the GVSN from the call. The server MUST include the GVSN, supplied in the UpdateCancel method call when completing subsequent or outstanding RequestVersionVector method calls for the replicated folder.

Remarks: A replicated folder session MUST have been established with the server for the replicated folder specified in the UpdateCancel call.