Приложения

Приложение А. Функции, константы и структуры RDS

А.5. Сервисные функции и макросы RDS

А.5.6. Операции с блоками и связями

А.5.6.30. rdsGetLineDescription – получить описание отрезка связи

Функция rdsGetLineDescription возвращает описания отрезка связи или шины с заданным номером и точек, которые он соединяет.

  BOOL RDSCALL rdsGetLineDescription(
    RDS_CHANDLE Conn,                // Связь
    int LineNum,                     // Номер отрезка
    RDS_PLINEDESCRIPTION pLine,      // Описание отрезка
    RDS_PPOINTDESCRIPTION pPoint1,   // Начальная точка
    RDS_PPOINTDESCRIPTION pPoint2    // Конечная точка
  );

Тип указателя на эту функцию

RDS_BChILdPdPd

Параметры

Conn (RDS_CHANDLE): Идентификатор связи или шины, которой принадлежит отрезок.
LineNum (int): Номер отрезка (нумерация отрезков в связях начинается с нуля).
pLine (RDS_PLINEDESCRIPTION): Указатель на структуру описания отрезка связи RDS_LINEDESCRIPTION, которую функция должна заполнить параметрами отрезка с номером LineNum. Если вызывающей программе не нужно это описание, в этом параметре можно передать NULL.
pPoint1 (RDS_PPOINTDESCRIPTION): Указатель на структуру описания точки связи RDS_POINTDESCRIPTION, которую функция должна заполнить параметрами начальной точки отрезка с номером LineNum. Если вызывающей программе не нужно это описание, в этом параметре можно передать NULL.
pPoint2 (RDS_PPOINTDESCRIPTION): Указатель на структуру описания точки связи, которую функция должна заполнить параметрами конечной точки отрезка с номером LineNum. Если вызывающей программе не нужно это описание, в этом параметре можно передать NULL.

Возвращаемое значение

TRUE, если отрезок с номером LineNum есть в связи Conn и размеры всех переданных структур правильные, FALSE в противном случае.

Примечания

Эта функция позволяет заполнить структуры, указатели на которые переданы в ее параметрах, описаниями отрезка связи с заданным номером и соединяемых им точек. В данном случае, начальная и конечная точка отрезка – условные понятия, они никак не связаны с фактическим направлением связи. Начальной точкой считается точка, номер которой заносится в поле nPoint1 структуры RDS_LINEDESCRIPTION, параметры этой точки записываются в структуру по указателю pPoint1. Конечной считается точка, номер которой занесен в поле nPoint2, и ее параметры записываются по указателю pPoint1.

Общее число отрезков связи можно узнать из поля NumLines структуры RDS_CONNDESCRIPTION, заполняемой функцией rdsGetConnDescription.

Пример

Пример использования функции rdsGetLineDescription приведен в §2.13.4 руководства программиста.

См. также

RDS_LINEDESCRIPTION, RDS_POINTDESCRIPTION, rdsGetConnDescription, RDS_CONNDESCRIPTION.