APIDo_​LoadLibrariesID

Resets and loads the active libraries.

    GSErrCode ACAPI_Automate (
        APIDo_LoadLibrariesID,
        const GS::Array<API_LibraryInfo>*     activeLibs
    );

 

Parameters

activeLibs Featuring API 18
[in] Specification of the active library folders.

 

Return Values

NoError
The function has completed with success.
APIERR_BADPARS
activeLibs is nullptr

For other common API errors see the API Errors document.

 

Remarks

This function is used to perform a Load Libraries command in the server application.

The active libraries will be dropped, and the new library set will be loaded. Note that BIMcloud / BIM Server Libraries cannot be loaded using this method.

 

Example


GS::Array<API_LibraryInfo>  lip;
API_LibraryInfo             li;
GSErrCode                   err;

li.location = IO::Location ("H:\\ARCHICAD 8.1\\ARCHICAD Library 8.1\\Background Images 8");
lip.Push (li);
li.location = IO::Location ("H:\\ARCHICAD 8.1\\ARCHICAD Library 8.1\\Textures 8");
lip.Push (li);

err = ACAPI_Automate (APIDo_LoadLibrariesID, &lip);
if (err == NoError)
    ACAPI_WriteReport ("APIDo_LoadLibrariesID ...OK", false);

Requirements

Version: API 4.1 or later
Header: APIdefs_Automate.h

 

See Also

API_LibraryInfo,
ACAPI_Automate, API Functions