ewdb_api_CreateAlarmAudit()

Prototype: |
int ewdb_api_CreateAlarmAudit( | EWDB_AlarmAuditStruct * pAudit);
Source File: | alarms/ewdb_api_CreateAlarmAudit.c
Description: | Creates or updates an alarm audit entry. If idAudit value in the structure is set, it updates the values for the audit. Otherwise, it creates a new audit entry.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
pAudit | EWDB_AlarmAuditStruct * | Pointed to the structure containing information about the audit entry to be created.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreateAlarmsCriteria()

Prototype: |
int ewdb_api_CreateAlarmsCriteria( | EWDB_AlarmsCritProgramStruct * pCrit);
Source File: | alarms/ewdb_api_CreateAlarmsCriteria.c
Description: | Creates or updates a criteria program entry in the database. If idCritProgram value in the structure is set, it updates the values for the program. Otherwise, it creates a new program entry.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
pCrit | EWDB_AlarmsCritProgramStruct * | Pointer to the structure containing the information about a criteria program to insert into the database.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreateAlarmsFormat()

Prototype: |
int ewdb_api_CreateAlarmsFormat( | EWDB_AlarmsFormatStruct * pForm);
Source File: | alarms/ewdb_api_CreateAlarmsFormat.c
Description: | Creates or updates a format entry in the database. If idFormat value in the structure is set, it updates the values for the format. Otherwise, it creates a new format entry.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
pForm | EWDB_AlarmsFormatStruct * | Pointer to the structure containing the information about a format to insert into the database.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreateAlarmsRecipient()

Prototype: |
int ewdb_api_CreateAlarmsRecipient( | EWDB_AlarmsRecipientStruct * pRecipient);
Source File: | alarms/ewdb_api_CreateAlarmsRecipient.c
Description: | Creates or updates a recipient entry in the database. If idRecipient value in the structure is set, it updates the values for the current recipient. Otherwise, it creates a new recipient entry.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
pRecipient | EWDB_AlarmsRecipientStruct * | Pointer to the structure containing the information about a recipient to insert into the database.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreateAlarmsRule()

Prototype: |
int ewdb_api_CreateAlarmsRule( | EWDB_AlarmsRuleStruct * pRule, EWDB_AlarmDeliveryUnionStruct * pDel);
Source File: | alarms/ewdb_api_CreateAlarmsRule.c
Description: | Creates or updates a rule entry in the database. If idRule value in the pRule structure is set, it updates the values for the current rule. Otherwise, it creates a new rule entry.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
pRule | EWDB_AlarmsRuleStruct * | Pointer to the structure containing the information about the rule to insert into the database.
pDel | EWDB_AlarmDeliveryUnionStruct * | Pointer to the structure containing the information about the delivery mechanism to associate with this rule.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreateCustomDelivery()

Prototype: |
int ewdb_api_CreateCustomDelivery( | int *pidRecipientDelivery, int idRecipient, EWDB_CustomDeliveryStruct *pCustom, int isAudit);
Source File: | alarms/ewdb_api_CreateCustomDelivery.c
Description: | If the current delivery is already in the database, it updates its values. Otherwise, it creates a new delivery and returns the database ID of the recipient delivery value (pidRecipientDelivery).
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
*pidRecipientDelivery | int | Pointer to the database ID of the recipient delivery for this delivery mechanism returned by this function.
idRecipient | int | Database ID of the recipient for whom this delivery is created.
*pCustom | EWDB_CustomDeliveryStruct | Information about the delivery to insert.
isAudit | int | If 1, the values should be inserted into the alarms audit tables, otherwise they should go to the actual alarm tables.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreateEmailDelivery()

Prototype: |
int ewdb_api_CreateEmailDelivery( | int *pidRecipientDelivery, int idRecipient, EWDB_EmailDeliveryStruct *pEmail, int isAudit);
Source File: | alarms/ewdb_api_CreateEmailDelivery.c
Description: | If the current delivery is already in the database, it updates its values. Otherwise, it creates a new delivery and returns the database ID of the recipient delivery value (pidRecipientDelivery).
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
*pidRecipientDelivery | int | Pointer to the database ID of the recipient delivery for this delivery mechanism returned by this function.
idRecipient | int | Database ID of the recipient for whom this delivery is created.
*pEmail | EWDB_EmailDeliveryStruct | Information about the delivery to insert.
isAudit | int | If 1, the values should be inserted into the alarms audit tables, otherwise they should go to the actual alarm tables.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreatePagerDelivery()

Prototype: |
int ewdb_api_CreatePagerDelivery( | int *pidRecipientDelivery, int idRecipient, EWDB_PagerDeliveryStruct *pPager, int isAudit);
Source File: | alarms/ewdb_api_CreatePagerDelivery.c
Description: | If the current delivery is already in the database, it updates its values. Otherwise, it creates a new delivery and returns the database ID of the recipient delivery value (pidRecipientDelivery).
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
*pidRecipientDelivery | int | Pointer to the database ID of the recipient delivery for this delivery mechanism returned by this function.
idRecipient | int | Database ID of the recipient for whom this delivery is created.
*pPager | EWDB_PagerDeliveryStruct | Information about the delivery to insert.
isAudit | int | If 1, the values should be inserted into the alarms audit tables, otherwise they should go to the actual alarm tables.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreatePhoneDelivery()

Prototype: |
int ewdb_api_CreatePhoneDelivery( | int *pidRecipientDelivery, int idRecipient, EWDB_PhoneDeliveryStruct *pPhone, int isAudit);
Source File: | alarms/ewdb_api_CreatePhoneDelivery.c
Description: | If the current delivery is already in the database, it updates its values. Otherwise, it creates a new delivery and returns the database ID of the recipient delivery value (pidRecipientDelivery).
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
*pidRecipientDelivery | int | Pointer to the database ID of the recipient delivery for this delivery mechanism returned by this function.
idRecipient | int | Database ID of the recipient for whom this delivery is created.
*pPhone | EWDB_PhoneDeliveryStruct | Information about the delivery to insert.
isAudit | int | If 1, the values should be inserted into the alarms audit tables, otherwise they should go to the actual alarm tables.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_CreateQddsDelivery()

Prototype: |
int ewdb_api_CreateQddsDelivery( | int *pidRecipientDelivery, int idRecipient, EWDB_QddsDeliveryStruct *pQdds, int isAudit);
Source File: | alarms/ewdb_api_CreateQddsDelivery.c
Description: | If the current delivery is already in the database, it updates its values. Otherwise, it creates a new delivery and returns the database ID of the recipient delivery value (pidRecipientDelivery).
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
*pidRecipientDelivery | int | Pointer to the database ID of the recipient delivery for this delivery mechanism returned by this function.
idRecipient | int | Database ID of the recipient for whom this delivery is created.
*pQdds | EWDB_QddsDeliveryStruct | Information about the delivery to insert.
isAudit | int | If 1, the values should be inserted into the alarms audit tables, otherwise they should go to the actual alarm tables.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeleteAlarmsFormat()

Prototype: |
int ewdb_api_DeleteAlarmsFormat( | int idFormat);
Source File: | alarms/ewdb_api_DeleteAlarmsFormat.c
Description: | Permanently deletes the format entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idFormat | int | Database ID of the format entry to delete.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeleteAlarmsRecipient()

Prototype: |
int ewdb_api_DeleteAlarmsRecipient( | int idRule);
Source File: | alarms/ewdb_api_DeleteAlarmsRecipient.c
Description: | Permanently deletes the recipient entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idRule | int | Database ID of the recipient entry to delete.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeleteAlarmsRule()

Prototype: |
int ewdb_api_DeleteAlarmsRule( | int idRule);
Source File: | alarms/ewdb_api_DeleteAlarmsRule.c
Description: | Permanently deletes the rule entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idRule | int | Database ID of the rule entry to delete.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeleteCritProgram()

Prototype: |
int ewdb_api_DeleteCritProgram( | int idRule);
Source File: | alarms/ewdb_api_DeleteCritProgram.c
Description: | Permanently deletes the criteria program entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idRule | int | Database ID of the criteria program entry to delete.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeleteCustomDelivery()

Prototype: |
int ewdb_api_DeleteCustomDelivery( | int idDelivery);
Source File: | alarms/ewdb_api_DeleteCustomDelivery.c
Description: | Permanently deletes the delivery entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idDelivery | int | Database ID of the delivery to deleted.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeleteEmailDelivery()

Prototype: |
int ewdb_api_DeleteEmailDelivery( | int idDelivery);
Source File: | alarms/ewdb_api_DeleteEmailDelivery.c
Description: | Permanently deletes the delivery entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idDelivery | int | Database ID of the delivery to deleted.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeletePagerDelivery()

Prototype: |
int ewdb_api_DeletePagerDelivery( | int idDelivery);
Source File: | alarms/ewdb_api_DeletePagerDelivery.c
Description: | Permanently deletes the delivery entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idDelivery | int | Database ID of the delivery to deleted.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeletePhoneDelivery()

Prototype: |
int ewdb_api_DeletePhoneDelivery( | int idDelivery);
Source File: | alarms/ewdb_api_DeletePhoneDelivery.c
Description: | Permanently deletes the delivery entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idDelivery | int | Database ID of the delivery to deleted.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_DeleteQddsDelivery()

Prototype: |
int ewdb_api_DeleteQddsDelivery( | int idDelivery);
Source File: | alarms/ewdb_api_DeleteQddsDelivery.c
Description: | Permanently deletes the delivery entry from the database.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
PARAMETER INFO
Parameter | Type | Description
idDelivery | int | Database ID of the delivery to deleted.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetAlarmsAudit()

Prototype: |
int ewdb_api_GetAlarmsAudit( | int idEvent, EWDB_AlarmAuditStruct *pAudit, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetAlarmsAudit.c
Description: | For a given idEvent, retrieves and writes to the pAudit buffer the information about the alarms that were sent for this event. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
idEvent | int | Database ID of the event for which alarm audits are being retrieved.
*pAudit | EWDB_AlarmAuditStruct | Preallocated array of audit structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetAlarmsCriteriaList()

Prototype: |
int ewdb_api_GetAlarmsCriteriaList( | int idCritProgram, EWDB_AlarmAuditStruct *pCrit, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetAlarmsCriteriaList.c
Description: | If idCritProgram is greater than 0, the function returns information about that criteria program only. Otherwise it retrieves and writes to the pCrit buffer the information about all criteria programs. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
idCritProgram | int | Database ID of the criteria program to retrieve. If present, the function will retrieve the information for that criteria program only. Otherwise, all programs are retrieved.
*pCrit | EWDB_AlarmAuditStruct | Preallocated array of criteria program structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetAlarmsFormats()

Prototype: |
int ewdb_api_GetAlarmsFormats( | int idFormat, EWDB_AlarmsFormatStruct *pFormat, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetAlarmsFormats.c
Description: | If idFormat is greater than 0, the function returns information about that format only. Otherwise it retrieves and writes to the pFormat buffer the information about all formats. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
idFormat | int | Database ID of the format to retrieve. If present, the function will retrieve the information for that format only. Otherwise, all formats are retrieved.
*pFormat | EWDB_AlarmsFormatStruct | Preallocated array of format structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetAlarmsRecipientList()

Prototype: |
int ewdb_api_GetAlarmsRecipientList( | int idRecipient, EWDB_AlarmsRecipientStruct *pRecipients, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetAlarmsRecipientList.c
Description: | If idRecipient is greater than 0, the function returns information about that recipient only. Otherwise it retrieves and writes to the pRecipient buffer the information about all recipients. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
idRecipient | int | Database ID of the recipient to retrieve. If present, the function will retrieve the information for that recipient only. Otherwise, all recipients are retrieved.
*pRecipients | EWDB_AlarmsRecipientStruct | Preallocated array of recipient structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetAlarmsRecipientSummary()

Prototype: |
int ewdb_api_GetAlarmsRecipientSummary( | int idRecipient, EWDB_AlarmsRecipientStructSummary *pSummary, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetAlarmsRecipientSummary.c
Description: | If idRecipient is greater than 0, the function returns summary information about that recipient only. Otherwise it retrieves and writes to the pSummary buffer the summary information about all recipients. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
idRecipient | int | Database ID of the recipient to retrieve. If present, the function will retrieve the summary information for that recipient only. Otherwise, all recipients are retrieved.
*pSummary | EWDB_AlarmsRecipientStructSummary | Preallocated array of summary structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetAlarmsRules()

Prototype: |
int ewdb_api_GetAlarmsRules( | int idRule, EWDB_AlarmsRuleStruct *pRule, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetAlarmsRules.c
Description: | If idRule is greater than 0, the function returns information about that rule only. Otherwise it retrieves and writes to the pRule buffer the information about all rules. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
idRule | int | Database ID of the rule to retrieve. If present, the function will retrieve the information for that rule only. Otherwise, all rules are retrieved.
*pRule | EWDB_AlarmsRuleStruct | Preallocated array of rule structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetAndIncrementCubeVersion()

Prototype: |
int ewdb_api_GetAndIncrementCubeVersion( | int idEvent, int * VersionNumber);
Source File: | alarms/ewdb_api_GetAndIncrementCubeVersion.c
Description: | Returns the current CUBE version number for the event and increments the number by one.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
idEvent | int | Database ID of the event for which CUBE version number is retrieved.
VersionNumber | int * | Pointer to the integer value representing the CUBE version number being returned.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetCustomDeliveries()

Prototype: |
int ewdb_api_GetCustomDeliveries( | int isAudit, int idDelivery, EWDB_CustomDeliveryStruct *pDelivery, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetCustomDeliveries.c
Description: | If idDelivery is greater than 0, the function returns delivery information about that delivery only. Otherwise it retrieves and writes to the pDelivery buffer the delivery information about all deliveries. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again. If isAudit is set, the retrieval is done from the audit tables, instead of from the actual alarm tables.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
isAudit | int | If 1, audit delivery entries will be retrieved. Otherwise, function returns actual alarm delivery entries.
idDelivery | int | Database ID of the delivery to retrieve. If present, the function will retrieve the information for that delivery only. Otherwise, all deliveries of this type are returned.
*pDelivery | EWDB_CustomDeliveryStruct | Preallocated array of delivery structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetEmailDeliveries()

Prototype: |
int ewdb_api_GetEmailDeliveries( | int isAudit, int idDelivery, EWDB_EmailDeliveryStruct *pDelivery, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetEmailDeliveries.c
Description: | If idDelivery is greater than 0, the function returns delivery information about that delivery only. Otherwise it retrieves and writes to the pDelivery buffer the delivery information about all deliveries. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again. If isAudit is set, the retrieval is done from the audit tables, instead of from the actual alarm tables.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
isAudit | int | If 1, audit delivery entries will be retrieved. Otherwise, function returns actual alarm delivery entries.
idDelivery | int | Database ID of the delivery to retrieve. If present, the function will retrieve the information for that delivery only. Otherwise, all deliveries of this type are returned.
*pDelivery | EWDB_EmailDeliveryStruct | Preallocated array of delivery structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetPagerDeliveries()

Prototype: |
int ewdb_api_GetPagerDeliveries( | int isAudit, int idDelivery, EWDB_PagerDeliveryStruct *pDelivery, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetPagerDeliveries.c
Description: | If idDelivery is greater than 0, the function returns delivery information about that delivery only. Otherwise it retrieves and writes to the pDelivery buffer the delivery information about all deliveries. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again. If isAudit is set, the retrieval is done from the audit tables, instead of from the actual alarm tables.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
isAudit | int | If 1, audit delivery entries will be retrieved. Otherwise, function returns actual alarm delivery entries.
idDelivery | int | Database ID of the delivery to retrieve. If present, the function will retrieve the information for that delivery only. Otherwise, all deliveries of this type are returned.
*pDelivery | EWDB_PagerDeliveryStruct | Preallocated array of delivery structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetPhoneDeliveries()

Prototype: |
int ewdb_api_GetPhoneDeliveries( | int isAudit, int idDelivery, EWDB_PhoneDeliveryStruct *pDelivery, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetPhoneDeliveries.c
Description: | If idDelivery is greater than 0, the function returns delivery information about that delivery only. Otherwise it retrieves and writes to the pDelivery buffer the delivery information about all deliveries. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again. If isAudit is set, the retrieval is done from the audit tables, instead of from the actual alarm tables.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
isAudit | int | If 1, audit delivery entries will be retrieved. Otherwise, function returns actual alarm delivery entries.
idDelivery | int | Database ID of the delivery to retrieve. If present, the function will retrieve the information for that delivery only. Otherwise, all deliveries of this type are returned.
*pDelivery | EWDB_PhoneDeliveryStruct | Preallocated array of delivery structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h

ewdb_api_GetQddsDeliveries()

Prototype: |
int ewdb_api_GetQddsDeliveries( | int isAudit, int idDelivery, EWDB_QddsDeliveryStruct *pDelivery, int *NumFound, int *NumRetrieved, int BufferLen);
Source File: | alarms/ewdb_api_GetQddsDeliveries.c
Description: | If idDelivery is greater than 0, the function returns delivery information about that delivery only. Otherwise it retrieves and writes to the pDelivery buffer the delivery information about all deliveries. It will write up to the BufferLen records, then return the number of found and retrieved items so that the calling routine can re-allocate the buffer and call again. If isAudit is set, the retrieval is done from the audit tables, instead of from the actual alarm tables.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_SUCCESS | Success.
EWDB_RETURN_FAILURE | Failure. See logfile for details.
EWDB_RETURN_WARNING | Successful return, but there were more entries found in the database than could be written into the supplied buffer.
PARAMETER INFO
Parameter | Type | Description
isAudit | int | If 1, audit delivery entries will be retrieved. Otherwise, function returns actual alarm delivery entries.
idDelivery | int | Database ID of the delivery to retrieve. If present, the function will retrieve the information for that delivery only. Otherwise, all deliveries of this type are returned.
*pDelivery | EWDB_QddsDeliveryStruct | Preallocated array of delivery structures to be filled.
*NumFound | int | Pointer to an integer where the function will write the number of items found in the database..
*NumRetrieved | int | Pointer to an integer where the function will write the number of items retrieved from the database..
BufferLen | int | Length of the input buffer - number of preallocated structures to be filled.
Group: | EWDB_ORA_API
Sub Group: | ALARMS_API
Language: | C
Location: | ./src/oracle/schema-working/src/include/ewdb_ora_api.h