Reads the contents of a Favorite file or folder and returns them without modifying the plan. ACAPI_Favorite_Read combined with ACAPI_Favorite_Create works much like ACAPI_Favorite_Import, however it gives more control, but it is less efficient.
GSErrCode ACAPI_Favorite_Read ( const IO::Location& location, GS::Array<API_Favorite> *favorites );
- [in] The path to the Favorite file or folder to read.
- [out] The parameters of the imported Favorites.
- The function has completed with success.
- The location isn’t a valid Favorite file or folder path.
For other common API errors see the API Errors document.
ExampleFor detailed example, please see the Favorite_Test example Add-On.
- Version: API 20 or later
- Header: ACAPinc.h