PA_UseVirtualStructure

4D - Documentation   Français   English   German   4D Plugin API, Command Theme List   4D Plugin API, Command Alphabetical List   Back   Previous   Next

version 2003


PA_UseVirtualStructure

ParameterTypeDescription
This command does not require any parameters

Description

The command PA_UseVirtualStructure tells 4D to henceforth use the virtual structure references (if supported) in all pending API calls.

By default, real structure is used. Note that this affects many API routines, in fact all routines using tables/fields numbers or names.

To know if the virtual structure mode is supported by 4D, call PA_VirtualStructureDefined. If it returns 1 then APIs of the Virtual structure theme can be used safely, otherwise they will not work or will return an error code.

The virtual structure is used when the 4D commands SET TABLE TITLES and SET FIELD TITLES are called.

Example

We want to temporarily work with virtual table numbers.

   //... previous code...
   if(PA_VirtalStructureDefined())
   {
      PA_UseVirtualStructure();
   //...all pending calls will use virtual structure
   // switch back to real structure
      PA_UseRealStructure();
   }
   else
   // Virtual structure not supported: Alert user, returns error, etc.

See Also

PA_UseRealStructure.

Error Handling

None


4D - Documentation   Français   English   German   4D Plugin API, Command Theme List   4D Plugin API, Command Alphabetical List   Back   Previous   Next