DN/External/curl-8.17.0/docs/libcurl/curl_multi_notify_disable.md

1.5 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol Added-in
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl curl_multi_notify_disable 3 libcurl
CURLMOPT_NOTIFYFUNCTION (3)
CURLMOPT_NOTIFYDATA (3)
curl_multi_notify_enable (3)
All
8.17.0

NAME

curl_multi_notify_disable - disable a notification type

SYNOPSIS

#include <curl/curl.h>
CURLMcode curl_multi_notify_disable(CURLM *multi_handle,
                                    unsigned int notification);

DESCRIPTION

Disables collecting the given notification type in the multi handle. A callback function installed via CURLMOPT_NOTIFYFUNCTION(3) is no longer called when this notification happens.

Only when a notification callback is installed and a notification is enabled are these collected and dispatched to the callback.

Several notification types can be enabled at the same time. Disabling an already disabled notification is not an error.

A notification can be enabled again via curl_multi_notify_enable(3).

%PROTOCOLS%

EXAMPLE

int main(void)
{
  int rc;
  CURLM *multi = curl_multi_init();

  rc = curl_multi_notify_disable(multi, CURLMNOTIFY_INFO_READ);
}

%AVAILABILITY%

RETURN VALUE

This function returns a CURLMcode indicating success or error.

CURLM_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

The return code is for the whole multi stack. Problems still might have occurred on individual transfers even when one of these functions return OK.