Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

int phMutex::unlock  ) 
 

Release the mutex.

This method should be called once for each successful call to the phMutex::lock() method. One should check the return code from phMutex::lock() and only unlock if the call was successful.

Returns:
The success of the method.
Return values:
phSUCCESS The thread successfully released the locked mutex.
phFAIL The thread failed to execute the method. This can be for a couple reasons:
  • the thread didn't own the mutex
  • the object is invalid/unallocated/uninitialized on the heap or stack
  • the object is allocated statically on the stack and the stack was over run because the system doesn't have a large enough stack size.

Definition at line 499 of file phMutex.cpp.





Copyright (C) 2002 - 2007 Philip D.S. Thoren ( pthoren@users.sourceforge.net )
University Of Massachusetts at Lowell
Robotics Lab
SourceForge.net Logo

Generated on Sat Jun 16 02:45:00 2007 for phission by  doxygen 1.4.4