CitrixRemoveInterrupt Function

Action

Removes the interrupt specification that is added by a call to CitrixAddInterrupt. Specifies exactly the same parameters that are provided by the call to CitrixAddInterrupt.

Include file

CitrixAPI.bdh

Syntax

CitrixRemoveInterrupt( in nReason  : number,
                       in sCaption : string allownull,
                       in nMatch   : number,
                       in nWindow  : number optional ): boolean;

Return value

true if the function succeeds
false otherwise

Parameter	Description
nReason	INTERRUPT_WindowCreate: An interrupt is triggered if a created window matches the specified conditions. INTERRUPT_WindowActivate: An interrupt is triggered if an activated window matches the specified conditions. INTERRUPT_WindowDestroy: An interrupt is triggered if a destroyed window matches the specified conditions. INTERRUPT_CaptionChange: An interrupt is triggered if a changed window caption matches the specified window caption (specified in the nMatch parameter) or the window with the nWindow ID changes its caption.
sCaption	The caption that triggers an interrupt if it matches the window caption (which is specified in the nMatch parameter). If this parameter is provided (and not null or “”) then the nWindow parameter will be ignored.
nMatch	Specify one of the following values (optional): MATCH_Exact (default): Case-sensitive comparison. MATCH_ExactNoCase: Case-insensitive comparison. MATCH_Wildcard: The search string must either begin or end with a '' character, which matches everything. The rest of the string is compared case sensitively. MATCH_WildcardNoCase: The search string must either begin or end with a '' character, which matches everything. The rest of the string is compared case insensitively. MATCH_RegExp: The search string is a regular expression. See the regular expression chapter for a description of Silk Performer's regular expression capability.
nWindow	If the sCaption parameter is not provided, then windows will be examined by comparing their ID’s against the nWindow parameter.