Display operator help for an alarm. The AddHelpLine() callback function gets called for each line in the help file. It is passed the helpText pointer in arg and a pointer to the line of help text in str.

If this method fails, you will need to call CAmvConn::BreakConnection().

Syntax

void OperHelpRequest(TCHAR *alarmId,

                    void AddHelpLine(void *arg,

                                    TCHAR *str),

                    void *helpText,

                    COR_STATUS *ret_stat);

Data Type

void

Example

static void S_AddHelpLine(void *arg, TCHAR *str)

{

   CListBox *box=(CListBox *)arg;

   box->AddString(str);

}

   

CAmvAlarm* alarm_ptr;

TCHAR id_buf[ALARM_ID_LEN+1];

CListBox HelpText;

amvConn->OperHelpRequest(alarm_ptr->ID(id_buf),

                       S_AddHelpLine,

                       (void *)HelpText,

                       &ret_stat);

More information

CAmvConn class member overview.

---