k2hpx_keyq_read

Returns a key/value pair from the K2hKeyQueue

Description

array k2hpx_keyq_read ( mixed $keyqhandle_res [, int $pos [, stringnull $pass ]] )

Returns a key/value pair from the K2hKeyQueue. This operation will not remove the key/value pair from the K2hKeyQueue.

Note

This operation will not remove the element from the K2hKeyQueue. Use k2hpx_keyq_pop to removes and returns the element instead.

Parameters

• keyqhandle_res
  Specifies the K2hKeyQueue file handle that k2hpx_keyq_handle returns.
• pos
  Specifies the position of the K2hKeyQueue.
• pass
  Specifies the password to decrypt the value.

Return Values

Returns a key/value pair.

See Also

• K2hQueue::read - Returns a key/value pair from the K2hQueue