File_Passwd_Common::_close()

File_Passwd_Common::_close() -- Closes a prior opened and locked file handle

Synopsis

mixed File_Passwd_Common::_close (resource &$file_handle)

Description

Closes a prior with File_Passwd_Common::_open() opened and locked file handle.

(package developer related)

Parameter

resource &$file_handle

the file handle to operate on

Return value

Returns TRUE on success, PEAR_Error on failure.

Table 29-1. Possible PEAR_Error values

Error CodeSummary
FILE_PASSWD_E_FILE_NOT_UNLOCKEDpasswd file couldn't be unlocked
FILE_PASSWD_E_FILE_NOT_CLOSEDpasswd file couldn't be closed

Note

This function can not be called statically.