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

   1 .TH "MEMCACHED_DELETE_BY_KEY" "3" "April 08, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_delete_by_key \- 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 .sp
  34 Delete a key
  35 .SH LIBRARY
  36 .sp
  37 C Client Library for memcached (libmemcached, \-lmemcached)
  38 .SH SYNOPSIS
  39 .sp
  40 .nf
  41 .ft C
  42 #include <libmemcached/memcached.h>
  43
  44 memcached_return_t
  45   memcached_delete (memcached_st *ptr,
  46                     const char *key, size_t key_length,
  47                     time_t expiration);
  48
  49 memcached_return_t
  50 memcached_delete_by_key (memcached_st *ptr,
  51                          const char *master_key, size_t master_key_length,
  52                          const char *key, size_t key_length,
  53                          time_t expiration);
  54 .ft P
  55 .fi
  56 .SH DESCRIPTION
  57 .sp
  58 memcached_delete() is used to delete a particular key.
  59 memcached_delete_by_key() works the same, but it takes a master key to
  60 find the given value.
  61 .sp
  62 Expiration works by placing the item into a delete queue, which means that
  63 it won\(aqt possible to retrieve it by the "get" command, but "add" and
  64 "replace" command with this key will also fail (the "set" command will
  65 succeed, however). After the time passes, the item is finally deleted from server memory.
  66 .sp
  67 Please note the the Danga memcached server removed support for expiration in
  68 the 1.4 version.
  69 .SH RETURN
  70 .sp
  71 A value of type \fBmemcached_return_t\fP is returned
  72 On success that value will be \fBMEMCACHED_SUCCESS\fP.
  73 Use memcached_strerror() to translate this value to a printable string.
  74 .sp
  75 If you are using the non\-blocking mode of the library, success only
  76 means that the message was queued for delivery.
  77 .SH HOME
  78 .sp
  79 To find out more information please check:
  80 \fI\%https://launchpad.net/libmemcached\fP
  81 .SH AUTHOR
  82 .sp
  83 Brian Aker, <\fI\%brian@tangent.org\fP>
  84 .SH SEE ALSO
  85 .sp
  86 memcached(1) libmemcached(3) memcached_strerror(3)
  87 .SH AUTHOR
  88 Brian Aker
  89 .SH COPYRIGHT
  90 2011, Brian Aker
  91 .\" Generated by docutils manpage writer.
  92 .\"
  93 .