DBgdvReturnPlanByName

Holt die Eigenschaften eines Plans aus der Planverwaltung

In der Planverwaltung sind zu jedem Plan die Koordinaten der linken unteren Ecke, die Koordinaten der rechten oberen Ecke, Plantyp, Planname, PlanID, und Ebene gespeichert. Diese Werte stehen auch im Plan selbst. Um diesen zu finden und ggf. die Werte zu vergleichen, oder um den Plan neu anzulegen, können die Werte aus der Datenbank geholt werden. Es ist dazu nur notwendig, dass die Planverwaltung mit DBgdvOpen geöffnet wurde und der Planname bekannt ist. DBgdvReturnPlanByName ermittelt dann alle anderen Werte und schreibt sie in den Record settings.

Parameter

root (PROOT)                                             [IN]

Das Handle der Datenbank, in der die entsprechende Planverwaltung geöffnet wurde.

name (char *)                                               [IN]

Der Name des Plans, über den Informationen gewünscht werden. Er muss in der Planverwaltung vorhanden sein, sonst wird eine Fehlermeldung generiert.

settings (GDV_PLAN_SETTINGS *) [IN/OUT]

Bei Prozedureintritt muss settings auf einen Record vom Typ GDV_PLAN_SETTINGS zeigen. Dieser wird dann von der Prozedur ausgefüllt, wenn der Plan gefunden wurde. Wenn der Plan nicht gefunden werden konnte, dann wird settings nicht verändert.

stufe (int)                                                      [IN]

reserviert, muss 1 sein.

Wenn weitere Informationen eingeführt werden, werden diese über stufe unterschieden.

gdvName (const char *)                              [IN]

Der Name der Planverwaltung. Ist gdvName = NULL, wird die geöffnete Planverwaltung benutzt.

Ergebnis

(T_ERROR)                                            [OUT]

Wenn der Plan gefunden wurde wird ERROR_OK zurückgegeben. Sonst wird eine der Fehlermeldungen aus error.h zurückgegeben. Wahrscheinlich sind die Meldungen GDV_CLOSED wenn die Planverwaltung nicht geöffnet wurde und GDV_NOT_EXISTING wenn der Plan nicht in der Planverwaltung vorhanden ist.

Deklaration

#include "database.h"

T_ERROR DLLENTRY DBgdvReturnPlanByName (

     PROOT                root,

     char *                  name,

     GDV_PLAN_SETTINGS *     settings,

     int                     stufe,

     const char *            gdvName

);