Advantage Client Engine
Gets a specified property from the data dictionary for a trigger.
UNSIGNED32 AdsDDGetTriggerProperty( ADSHANDLE hObject,
UNSIGNED8 *pucTriggerName,
UNSIGNED16 usPropertyID,
VOID *pvProperty,
UNSIGNED16 *pusPropertyLen );
hObject (I) |
Handle of a database connection. |
pucTriggerName (I) |
The name of the trigger in the data dictionary. |
usPropertyID (I) |
The property to retrieve. (see below for possible values.) |
pvProperty (O) |
A buffer to hold the property value. |
pusPropertyLen (I/O) |
Length of given buffer on input, length of returned data on output. |
AdsDDGetTriggerProperty will retrieve the specified property of the trigger from the data dictionary.
The pucTriggerName parameter should be qualified with the table name the trigger belongs to followed by two colon characters ( :: ). For example, "Customers::AfterInsertTrig" would specify you want the property for the trigger called "AfterInsertTrig" that belongs to the "Customers" table.
The following are the valid values for usPropertyID:
usPropertyID |
Description |
ADS_DD_TRIG_EVENT_TYPE |
Type of trigger event this trigger fires on. See AdsDDCreateTrigger for details on event types. The flag is returned as a 4-byte (UNSIGNED32) number in pvProperty. |
ADS_DD_TRIG_TRIGGER_TYPE |
Type of trigger (before, after, etc.). See AdsDDCreateTrigger for details on trigger types. The flag is returned as a 4-byte (UNSIGNED32) number in pvProperty. |
ADS_DD_TRIG_CONTAINER_TYPE |
Type of trigger container. See AdsDDCreateTrigger for details on container types. The flag is returned as a 4-byte (UNSIGNED32) number in pvProperty. |
ADS_DD_TRIG_CONTAINER |
Name of the trigger container. The container name is returned as a NULL terminated string in the pvProperty. |
ADS_DD_TRIG_FUNCTION_NAME |
Name of the trigger function in the container. The function name is returned as a NULL terminated string in the pvProperty. |
ADS_DD_TRIG_PRIORITY |
Priority of the trigger. The priority is returned as a 4-byte (UNSIGNED32) number in pvProperty. |
ADS_DD_TRIG_OPTIONS |
Bitmask of trigger options. See AdsDDCreateTrigger for details on options. The flag is returned as a 4-byte (UNSIGNED32) number in pvProperty. |
ADS_DD_TRIG_TABLENAME |
Name of the table the trigger belongs to. The table name is returned as a NULL terminated string in the pvProperty. |
ADS_DD_COMMENT |
Returns the trigger description in pvProperty. The description is returned as a NULL terminated string in the pvProperty. |