aecFPL_deleteLoad - PDS - 2011 R1 - Reference

FrameWorks Plus Programmer's Reference

PPMProductFamily
3D Design and Visualization
PPMProduct
PDS
PPMCategory
Reference

int aecFPL_deleteLoad (id, file);
long id;
int file;

Arguments:

Inputs

  • id is the ID of the load to be deleted.

  • file is the file number of the model that contains the load to be deleted. This must always be 0.

Description:

This function deletes the load with the load identification number "id". This number can be obtained from the aecFPL_queryLoad function. The file argument is the reference file partition number. The delete load function works only for loads in the local (master file) model, and thus file must be zero. It is included as an argument only for consistency with the query load function and to ensure that a load from the local model is not inadvertently deleted after a load is selected from an attached partition.

Returns:

This function returns SUCCESS (0) if successful. Otherwise, it returns a non-zero error number.

See also: