rar_comment_get(3) php man page | unix.com

RAR_COMMENT_GET(3)							 1							RAR_COMMENT_GET(3)

RarArchive::getComment - Get comment text from the RAR archive

       Object oriented style (method):

SYNOPSIS
       public string RarArchive::getComment (void  )

DESCRIPTION
       Procedural style:
       string rar_comment_get (RarArchive  $rarfile)

	Get the (global) comment stored in the RAR archive. It may be up to 64 KiB long.

       Note

	       This extension does not support comments at the entry level.

PARAMETERS
	      o $rarfile
		- A RarArchive object, opened with rar_open(3).

RETURN VALUES
	Returns the comment or NULL if there is none.

       Note

	       RAR has currently no support for unicode comments. The encoding of the result of this function is not specified, but it will proba-
	      bly be Windows-1252.

EXAMPLES
       Example #1

	      Object oriented style

	      <?php
	      $rar_arch = RarArchive::open('commented.rar');
	      echo $rar_arch->getComment();
	      ?>

	      The above example will output something similar to:

	      This is the comment of the file commented.rar.

       Example #2

	      Procedural style

	      <?php
	      $rar_arch = rar_open('commented.rar');
	      echo rar_comment_get($rar_arch);
	      ?>

PHP Documentation Group 													RAR_COMMENT_GET(3)