K2hash::open

Opens the k2h file

Description

 public bool K2hash::open ( string $filepath , bool $readonly [, bool $removefile [, bool $fullmap [, int $maskbitcnt [, int $cmaskbitcnt [, int $maxelementcnt [, int $pagesize ]]]]]] )

Opens the k2hash (.k2h) file with read and write access.

Parameters

• filepath
  Specifies a k2hash (.k2h) file path.
• readonly
  Specifies true if open with read only access, otherwise false.
• removefile
  Specifies true if removing the k2hash (.k2h) file when no process attaches the file.
• fullmap
  Specifies true if the whole data of the file maps to memory.
• maskbitcnt
  Specifies key mask bit. The default value is 8.
• cmaskbitcnt
  Specifies the key collision mask bit. The default value is 4.
• maxelementcnt
  Specifies the max number of duplicated elements if a hash collision occurs. The default value is 1024(bytes).
• pagesize
  Specifies the block size of data. The default value is 512(bytes).

Return Values

Returns true on success or false on failure.

See Also

• K2hash::close - Closes the k2h file
• K2hash::openMem - Open k2hash as volatile(on memory)
• K2hash::openRO - Read the k2hash file
• K2hash::openRW - Edit the k2hash file
• K2hash::openTempfile - Edit the k2hash file on temporary file system