Modifies the story structure.
GSErrCode ACAPI_Environment ( APIEnv_ChangeStorySettingsID, API_StoryCmdType* storyCmd );
- [in] Action parameters to change the story settings.
- The function has completed with success.
nullptror contains invalid value:
- – the
indexis out of the range of existing stories,
- – the
actionfield is invalid.
- No open project.
- Low memory condition.
For other common API errors see the API Errors document.
This function is used to perform story settings related commands. The command is specified by the
action field of the
storyCommand parameter. Possible values and the required parametrization are described at the API_StoryCmdID structure.
If this function is called with APIStory_Delete parameter, it performs complete operations. Otherwise this function is a non-undoable data structure modifier function. See more details on this topic at Command Overview.
- Version: API 2.1 or later
- Header: APIdefs_Environment.h