Adobe ColdFusion 8

getGatewayID

Description

Returns the gateway ID field of the CFEvent object.

Category

Event Gateway Development

Syntax

String getGatewayID(CFEvent event)

See also

CFEvent, CFML CFEvent structure, "CFEvent class" in the ColdFusion Developer's Guide

Returns

The gateway ID of the CFEvent object, or null.

Usage

Most gateways do not need to use this method. The gateway ID is set in the CFEvent constructor and normally corresponds to the gateway that is handling the event.