mirror of
https://github.com/php/doc-es.git
synced 2026-03-26 08:22:08 +01:00
6110957b67
git-svn-id: https://svn.php.net/repository/phpdoc/es/trunk@329069 c90b9560-bf6c-de11-be94-00142212c4b1
124 lines
3.1 KiB
XML
124 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 0d604bbc9d3b741d53e7fac26f5b24c306751e9a Maintainer: regiemix Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
|
|
<refentry xml:id='samconnection.remove' xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>SAMConnection::remove</refname>
|
|
<refpurpose>
|
|
Elimina un mensaje de una cola
|
|
</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>SAMMessage</type><methodname>SAMConnection::remove</methodname>
|
|
<methodparam><type>string</type><parameter>target</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>properties</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Elimina un mensaje de una cola.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>target</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
La identidad de la cola de la cual se va a eliminar el mensaje.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>properties</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Un array asociativo opcional de propiedades, que describen otros
|
|
parámetros para controlar la operación de eliminado.
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Nombre de propiedad</entry>
|
|
<entry>Valores posibles</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>SAM_CORRELID</entry>
|
|
<entry>
|
|
Este es el identificador de correlación del mensaje.
|
|
Es retornado típicamente por una petición "send".
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>SAM_MESSAGEID</entry>
|
|
<entry>
|
|
Este es el identificador del mensaje que se va a
|
|
eliminar.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Este método devuelve &false; en caso de error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Eliminación de un mensaje de una cola a partir del identificador de mensaje</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
if (!$conn->remove('queue://receive/test', array(SAM_MESSAGEID => $messageId))) {
|
|
// La eliminación falló!
|
|
echo "Eliminación fallida ($conn->errno) $conn->error";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|