Edit

Share via


GetEventsType.Watermark Property

Definition

The Watermark property gets or sets a string that represents an event bookmark in the mailbox event queue. This property is required. This is a read/write property.

public:
 property System::String ^ Watermark { System::String ^ get(); void set(System::String ^ value); };
public string Watermark { get; set; }
Public Property Watermark As String

Property Value

The Watermark property returns a string.

Remarks

This watermark describes where the GetEvents operation begins to return events. The watermark that is passed to GetEvents must be the last watermark that was returned to the client. If this is the first call to GetEvents after Subscribe, the watermark that is returned by Subscribe should be passed to GetEvents. If GetEvents has already been called, the watermark that is passed to the next GetEvents call must be the watermark of the last event that is returned from the previous GetEvents call.

If the Watermark property is set with an invalid watermark, an ErrorInvalidWatermark error is returned to the client application.

Applies to