diff --git a/reference/rar/functions/rar-close.xml b/reference/rar/functions/rar-close.xml index f2da85e5b1..e001e23830 100644 --- a/reference/rar/functions/rar-close.xml +++ b/reference/rar/functions/rar-close.xml @@ -1,12 +1,13 @@ - + rar_close Close Rar archive and free all resources - - Description + + + &reftitle.description; boolrar_close resourcerar_file @@ -14,10 +15,31 @@ Close Rar archive and free all allocated resources. + + + + &reftitle.parameters; - rar_close returns &false; on error. + + + rar_file + + + A Rar file resource, opened with rar_open. + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + rar_entry_get Get entry object from the Rar archive - - Description + + + &reftitle.description; RarEntryrar_entry_get resourcerar_file @@ -15,9 +16,45 @@ Get entry object from the Rar archive. - - <function>Rar::</function> example - + + + + &reftitle.parameters; + + + + rar_file + + + A Rar file resource, opened with rar_open. + + + + + entry_name + + + Path to the entry within the Rar archive. + + + + + + + + + &reftitle.returnvalues; + + rar_get_entry returns entry object or &false; on error. + + + + + &reftitle.examples; + + + <function>rar_entry_get</function> example + ]]> - - - - rar_get_entry returns entry object or &false; on error. + + + + Rar::extract Extract entry from the archive - - Description - - boolRar::extract - stringdir - stringfilepath - + + + &reftitle.description; + + Rar + + boolextract + stringdir + stringfilepath + + Rar::extract extracts entry's data to the dir. It will create new file in the specified dir with the name identical to the entry's name. - If parameter filepath is specified instead - dir, Rar::extract will extract - entry's data to the specified file. - - <function>Rar::extract</function> example - + + + + &reftitle.parameters; + + + + dir + + + Path to the directory where files should be extracted. + + + + + filepath + + + If parameter filepath is specified instead + dir, Rar::extract will extract + entry's data to the specified file. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + + <function>Rar::extract</function> example + extract(false, '/dir/to/new_name.txt'); // create /dir/to/new_name.txt ?> ]]> - - - - How to extract all files in archive: - + + + + How to extract all files in archive: + ]]> - - - - &return.success; + + + + Rar::getAttr Get attributes of the entry - - Description - - intRar::getAttr - - + + + &reftitle.description; + + Rar + + intgetAttr + + + Rar::getAttr returns attributes of the archive entry. - - <function>Rar::getAttr</function> example - + + + + &reftitle.returnvalues; + + Returns the attributes or &false; on error. + + + + + &reftitle.examples; + + + <function>Rar::getAttr</function> example + ]]> - - - - Rar::getAttr returns &false; on error. - - - See also Rar::getHostOs. + + + + + + &reftitle.seealso; + + + + + + + + Rar::getCrc Get CRC of the entry - - Description - - intRar::getCrc - - + + + &reftitle.description; + + Rar + + intgetCrc + + + Rar::getCrc returns CRC of the archive entry. - - <function>Rar::getCrc</function> example - - -?> -]]> - - + + &reftitle.returnvalues; - Rar::getCrc returns &false; on error. + Returns the CRC of the archive entry or &false; on error. + + Rar::getFileTime Get entry last modification time - - Description - - stringRar::getFileTime - - + + + &reftitle.description; + + Rar + + stringgetFileTime + + + - Rar::getFileTime returns entry last modification - time as string in format YYYY-MM-DD HH:II:SS. - - - <function>Rar::</function> example - - -]]> - - - - Rar::getFileTime returns &false; on error. + Gets entry last modification time. + + + &reftitle.returnvalues; + + Returns entry last modification time as string in format + YYYY-MM-DD HH:II:SS, or &false; on error. + + + + Rar::getHostOs Get entry host OS - - Description - - intRar::getHostOs - - + + + &reftitle.description; + + Rar + + intgetHostOs + + + Rar::getHostOs return code of the host OS of the archive entry. - - <function>Rar::getHostOs</function> example - + + + + &reftitle.returnvalues; + + Returns the code of the host OS, or &false; on error. + + + + + &reftitle.examples; + + + <function>Rar::getHostOs</function> example + getHostOs()) { ?> ]]> - - - - Rar::getHostOs returns &false; on error. + + + + Rar::getMethod Get pack method of the entry - - Description - - intRar::getMethod - - + + + &reftitle.description; + + Rar + + intgetMethod + + + Rar::getMethod returns number of the method used when adding current archive entry. - - <function>Rar::getMethod</function> example - + + + + &reftitle.returnvalues; + + Returns the method number or &false; on error. + + + + + &reftitle.examples; + + + <function>Rar::getMethod</function> example + getMethod(); ?> ]]> - - - - Rar::getMethod returns &false; on error. + + + + Rar::getName Get name of the entry - - Description - - stringRar::getName - - + + + &reftitle.description; + + Rar + + stringgetName + + + Rar::getName returns full name of the archive entry. - - <function>Rar::getName</function> example - + + + + &reftitle.returnvalues; + + Returns the entry name as a string, or &false; on error. + + + + + &reftitle.examples; + + + <function>Rar::getName</function> example + getName(); ?> ]]> - - - - Rar::getName returns &false; on error. + + + + Rar::getPackedSize Get packed size of the entry - - Description - - intRar::getPackedSize - - + + + &reftitle.description; + + Rar + + intgetPackedSize + + + Get packed size of the archive entry. - - <function>Rar::</function> example - + + + + &reftitle.returnvalues; + + Returns the packed size, or &false; on error. + + + + + &reftitle.examples; + + + <function>Rar::getPackedSize</function> example + getName() . " = " . $entry->getPackedSize() . " ?> ]]> - - - - Rar::getPackedSize returns &false; on error. + + + + Rar::getUnpackedSize Get unpacked size of the entry - - Description - - intRar::getUnpackedSize - - + + + &reftitle.description; + + Rar + + intgetUnpackedSize + + + Get unpacked size of the archive entry. - - <function>Rar::getUnpackedSize</function> example - + + + + &reftitle.returnvalues; + + Returns the unpacked size, or &false; on error. + + + + + &reftitle.returnvalues; + + + <function>Rar::getUnpackedSize</function> example + getName() . " = " . $entry->getPackedSize() . ?> ]]> - - - - Rar::getUnpackedSize returns &false; on error. + + + + Rar::getVersion Get version of the archiver used to add the entry - - Description - - intRar::getVersion - - + + + &reftitle.description; + + Rar + + intgetVersion + + + Get version of the archiver used to add the archive entry. - - <function>Rar::getVersion</function> example - + + + + &reftitle.returnvalues; + + Returns the version or &false; on error. + + + + + &reftitle.examples; + + + <function>Rar::getVersion</function> example + getVersion(); ?> ]]> - - - - Rar::getVersion returns &false; on error. + + + + rar_list Get entries list from the Rar archive - - Description + + + &reftitle.description; arrayrar_list resourcerar_file @@ -14,9 +15,37 @@ Get entries list from the Rar archive. - - <function>Rar::</function> example - + + + + &reftitle.parameters; + + + + rar_file + + + A Rar file resource, opened with rar_open. + + + + + + + + + &reftitle.returnvalues; + + rar_list returns array of entries or &false; on error. + + + + + &reftitle.examples; + + + <function>rar_list</function> example + ]]> - - - - rar_list returns array of entries or &false; on error. + + + + rar_open Open Rar archive - - Description + + + &reftitle.description; resourcerar_open stringfilename @@ -15,10 +16,39 @@ Open specified Rar archive and return Rar file resource. + + + + &reftitle.parameters; + + + + filename + + + Path to the Rar archive. + + + + + password + + + A plain password, if needed. + + + + + + + + + &reftitle.returnvalues; rar_open returns Rar file resource or &false; on error. +