IPWorks Auth 2020 .NET Edition

Questions / Feedback?

SearchPage Event

Fired for every page returned from a search operation.

Syntax

public event OnSearchPageHandler OnSearchPage;

public delegate void OnSearchPageHandler(object sender, LdapSearchPageEventArgs e);

public class LdapSearchPageEventArgs : EventArgs {
  public int MessageId { get; }
  public string DN { get; }
  public int ResultCode { get; }
  public string ResultDescription { get; }
  public bool CancelSearch { get; set; }
}
Public Event OnSearchPage As OnSearchPageHandler

Public Delegate Sub OnSearchPageHandler(sender As Object, e As LdapSearchPageEventArgs)

Public Class LdapSearchPageEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As Integer
  Public ReadOnly Property DN As String
  Public ReadOnly Property ResultCode As Integer
  Public ReadOnly Property ResultDescription As String
  Public Property CancelSearch As Boolean
End Class

Remarks

This event is where the client can decide whether to continue with the Search operation or not. The signature is very similar to the SearchComplete event, with the addition of a CancelSearch parameter. If the search should be canceled (no more pages), the CancelSearch parameter should be set to true.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 .NET Edition - Version 20.0 [Build 8155]