Controls the environmental data of the server application.
GSErrCode ACAPI_Environment ( API_EnvironmentID code, void* par1 = nullptr, void* par2 = nullptr, void* par3 = nullptr );
Parameters
- code
- [in] Environment function identifier.
- par1
- [in/out] The parameter depends on the
code
parameter. - par2
- [in/out] The parameter depends on the
code
parameter. - par3
- [in/out] The parameter depends on the
code
parameter.
Return Values
NoError
- The environment function completed with success.
APIERR_BADID
- Invalid
code
parameter was passed.
More return values can be found at the description of each environment function.
Remarks
This function is used to access the environmental information of the server application.
The type of the environment function is specified with the code
parameter.
Description
General environment
Returns information about the current application.
Returns information about the current project file.
Returns the project sharing data in the case of a TeamWork project.
Returns information about the ‘Project Info’ dialog.
Changes the data of the ‘Project Info’ dialog.
Active libraries
Returns the list of loaded libraries.
Changes the list of loaded libraries.
Resets the loaded libraries.
Instructs the user to select a new library folder in a dialog.
Registers a new folder into the list of active libraries.
Checks the currently loaded libraries.
Sets the overwrite mode for the library part create function.
Creates a new folder inside a loaded library.
Copies files into a folder inside a loaded library.
Active Settings
Gets the actual toolbox mode.
Sets the actual toolbox mode.
Returns information on the toolbox.
Returns the current state of the autogroup mode.
Returns the current state of the Suspend Groups mode.
Returns the actual display & output options.
Changes the actual display & output options.
Returns the data of the installed stories.
Modifies the story structure.
Returns the current ghost story settings.
Returns the preferences data.
Returns the preferences data.
Returns information on sun parameters.
Returns information on location parameters.
Changes the place settings.
May the current user change the place settings now?
Returns the Location data stored for the project.
Sets the Location data of the project.
Returns the transformation matrix that transforms points given in the Project Origin’s coordinate system into the Survey Point’s coordinate system.
Checks the visibility of the Survey Point.
Sets the visibility of the Survey Point.
Returns the lock state of the Survey Point.
Locks or Unlocks the Survey Point.
Returns arc difference in output.
Returns information on curve tracing parameters.
Returns information on the 3D projection settings.
Changes the 3D projection settings.
Returns information on the photorendering settings.
Changes the photorendering settings.
Gets the names of all named Rendering Scenes.
Sets the current Rendering Scene to the given named Scene.
Returns the 3D image item settings.
Changes the 3D image item settings.
Retrieves the 3D window settings.
Changes the 3D window settings.
Retrieves the 3D cutting planes settings.
Changes the 3D cutting planes.
Retrieves the index of the current layer combination.
Activates a layer combination.
Retrieves the index of the current pen set.
Retrieves the lines of the grid-based drawing numbering system.
Returns the state of the automatic intersection flag.
Changes the automatic intersection flag.
Checks whether attached objects are processed and returned during primitive decomposition.
Sets whether attached objects should be processed and returned during primitive decomposition.
System Environment
Gets visibility of application.
Changes visibility of application.
Gets miscellaneous information about application.
Gets general information about the current printer.
Gets general information about the plotter.
Gets various printer settings.
Returns the location of special application folders.
Creates a new layout.
Returns the current layout properties.
Changes the current layout properties.
Returns the 3D document setting default values.
Changes the 3D document setting default values.
Returns the 3D document settings of the specified database.
Changes the 3D document settings of the specified database.
Changes the partial structure display options for the current database.
Changes the partial structure display options for the current database.
Returns the reference guid of the given library part.
Returns the unique ID of the library part as string.
Returns the current lock status of the given library part.
Deletes the given embedded library item (folder or library part).
Returns a copy of the current GDL globals (APIEnv_GetGdlUserGlobalsHandleID was removed).
Destroys the previously copied GDL globals handle.
Returns if applicaton is in curtain wall editing mode.
Returns if applicaton is in stair editing mode.
Returns if applicaton is in beam editing mode.
Returns if applicaton is in column editing mode.
Returns if the current user has the specifed access right.
Returns GDL environment date information.
Changes GDL environment date.
Requirements
- Version: API 2.1 or later
- Header: ACAPinc.h, APIdefs_Environment.h