11.4 PSYX Manager

11.4.2 PSYX Maintenance

long LoadPSYX(char *name, long ID);
 

Loads the PSYX named by name; if name is NULL, ID is used instead. The return value is the loaded PSYX's ID if the PSYX was loaded, or 0 if the load failed.

PSYXerror is set to pe_unknown if the PSYX name or ID is bad. If the PSYX does not accept the pInitialize message, PSYXerror is set to pe_init_fail.

To insure that the PSYX is not purged during some other memory operation, call SecurePSYX(). Call ReleasePSYX() when you no longer need the PSYX.

int PurgePSYX(long ID);
 

Purges the PSYX with ID ID if it is not secured. TRUE is returned if the PSYX was succesfully purged.

PSYXerror is set to pe_unknown if the PSYX ID is bad. If the PSYX was not loaded, PSYXerror is set to pe_not_loaded. If the PSYX does not accept the pDenitialize message, PSYXerror is set to pe_deinit_fail.

void PurgePSYXs(void);
 

Calls PurgePSYX() on all loaded PSYXs that are not secured.

PSYXerror is set to pe_unknown if the PSYX ID is bad. If any PSYX does not accept the pDenitialize message, PSYXerror is set to pe_deinit_fail.

int SecurePSYX(long ID);
 

Locks the PSYX into memory so that it may not be purged. Every call to SecurePSYX() should be balanced by a call to ReleasePSYX(). If the PSYX has been purged, it will be reloaded. TRUE is returned if the PSYX is secured.

PSYXerror is set to pe_unknown if the PSYX ID is bad. If the PSYX does not accept the pInitialize message, PSYXerror is set to pe_init_fail.

int ReleasePSYX(long ID);
 

Unlocks the PSYX so that it may again be unloaded. Every call to ReleasePSYX() should be preceded by a call to SecurePSYX(). TRUE is returned if the PSYX is released.

Don't worry that you may release a PSYX some other process is using; SecurePSYX() and ReleasePSYX() take care of this problem by keeping track of how many secure and releases have been called.

PSYXerror is set to pe_unknown if the PSYX ID is bad. If the PSYX was not loaded, PSYXerror is set to pe_not_loaded. If the PSYX was not secured, PSYXerror is set to pe_not_secured.

int IsPSYXUnpurged(long ID);
 

Returns TRUE if the specified PSYX is loaded, or FALSE if it is unloaded.

PSYXerror is set to pe_unknown if the PSYX ID is bad. If the PSYX was not loaded, PSYXerror is set to pe_not_loaded.

int IsPSYXSecured(long ID);
 

Returns TRUE if the PSYX is loaded and secured, or FALSE if it is unloaded or not secured.

PSYXerror is set to pe_unknown if the PSYX ID is bad. If the PSYX was not loaded, PSYXerror is set to pe_not_loaded.

Generated with CERN WebMaker