'\" t
.\"     Title: tlsrpt_cancel_delivery_request
.\"    Author: Boris Lohner
.\" Generator: Asciidoctor 2.0.26
.\"      Date: 2026-09-01
.\"    Manual: tlsrpt_cancel_delivery_request
.\"    Source: tlsrpt_cancel_delivery_request
.\"  Language: English
.\"
.TH "TLSRPT_CANCEL_DELIVERY_REQUEST" "3" "2026-09-01" "tlsrpt_cancel_delivery_request" "tlsrpt_cancel_delivery_request"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
tlsrpt_cancel_delivery_request \- marks the delivery request as cancelled
.SH "SYNOPSIS"
.sp
#include <tlsrpt.h>
.sp
int tlsrpt_cancel_delivery_request(struct tlsrpt_dr_t** pdr)
.SH "DESCRIPTION"
.sp
The \f(CRtlsrpt_cancel_delivery_request\fP function marks the delivery request as cancelled.
This is done by an internal library "dummy error" \f(CRTLSRPT_ERR_TLSRPT_CANCELLED\fP which, like all errors, will prevent the delivery request from being sent out.
The function then calls \f(CRtlsrpt_finish_delivery_request\fP, which will do all the clean\-up of used resources.
.SH "RETURN VALUE"
.sp
The tlsrpt_cancel_delivery_request function returns 0 on success and a combined error code on failure.
The combined error code can be analyzed with the \fItlsrpt_strerror\fP function.
.SH "SEE ALSO"
.sp
man:tlsrpt_init_delivery_request[3], man:tlsrpt_finish_delivery_request[3], man:tlsrpt_strerror[3], man:tlsrpt_error_code_is_internal[3]
.SH "AUTHOR"
.sp
Boris Lohner