git.m6w6.name Git - awesomized/libmemcached/blob - docs/man/memcached_delete.3

   1 .TH "MEMCACHED_DELETE" "3" "October 26, 2011" "1.0.2" "libmemcached"
   2 .SH NAME
   3 memcached_delete \- libmemcached Documentation
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .SH SYNOPSIS
  34 .sp
  35 #include <libmemcached/memcached.h>
  36 .INDENT 0.0
  37 .TP
  38 .B memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
  39 .UNINDENT
  40 .INDENT 0.0
  41 .TP
  42 .B memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);
  43 .UNINDENT
  44 .sp
  45 Compile and link with \-lmemcached
  46 .SH DESCRIPTION
  47 .sp
  48 \fBmemcached_delete()\fP is used to delete a particular key.
  49 \fBmemcached_delete_by_key()\fP works the same, but it takes a master key
  50 to find the given value.
  51 .sp
  52 Expiration works by placing the item into a delete queue, which means that
  53 it won\(aqt be possible to retrieve it by the "get" command. The "add" and
  54 "replace" commands with this key will also fail (the "set" command will
  55 succeed, however). After the time passes, the item is finally deleted from server memory.
  56 .sp
  57 Please note the the Danga memcached server removed tests for expiration in
  58 the 1.4 version.
  59 .SH RETURN
  60 .sp
  61 A value of type \fBmemcached_return_t\fP is returned
  62 On success that value will be \fBMEMCACHED_SUCCESS\fP.
  63 Use \fBmemcached_strerror()\fP to translate this value to a printable
  64 string.
  65 .sp
  66 If you are using the non\-blocking mode of the library, success only
  67 means that the message was queued for delivery.
  68 .SH HOME
  69 .sp
  70 To find out more information please check:
  71 \fI\%http://libmemcached.org/\fP
  72 .SH AUTHOR
  73 .sp
  74 Brian Aker, <\fI\%brian@tangent.org\fP>
  75 .SH SEE ALSO
  76 .sp
  77 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  78 .SH AUTHOR
  79 Brian Aker
  80 .SH COPYRIGHT
  81 2011, Brian Aker DataDifferential, http://datadifferential.com/
  82 .\" Generated by docutils manpage writer.
  83 .\"
  84 .