.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "TSCACHEREMOVE" "3ts" "Jan 06, 2024" "9.2" "Apache Traffic Server"
.SH NAME
TSCacheRemove \- TSCacheRemove API function
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <ts/ts.h>
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%TSAction\fP TSCacheRemove(\fI\%TSCont\fP contp, \fI\%TSCacheKey\fP key) 
.UNINDENT
.SH DESCRIPTION
.sp
Removes the object corresponding to \fIkey\fP from the cache.
.sp
If the object was removed successfully, the cache calls \fIcontp\fP back with the
event \fI\%TS_EVENT_CACHE_REMOVE\fP\&. If the object was not found in the cache,
the cache calls \fIcontp\fP back with the event
\fI\%TS_EVENT_CACHE_REMOVE_FAILED\fP\&.
.sp
In both of these callbacks, the user (\fIcontp\fP) does not have to do
anything.  The user does not get any vconnection from the cache, since
no data needs to be transferred.  When the cache calls \fIcontp\fP back with
\fI\%TS_EVENT_CACHE_REMOVE\fP, the remove has already been committed.
.SH COPYRIGHT
2024, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.