docs/libcurl/opts/CURLINFO_RTSP_SESSION_ID.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLINFO_RTSP_SESSION_ID 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
  24
  25 .SH NAME
  26 CURLINFO_RTSP_SESSION_ID \- get RTSP session ID
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RTSP_SESSION_ID, char **id);
  31 .SH DESCRIPTION
  32 Pass a pointer to a char pointer to receive a pointer to a string holding the
  33 most recent RTSP Session ID.
  34
  35 Applications wishing to resume an RTSP session on another connection should
  36 retrieve this info before closing the active connection.
  37
  38 The \fBid\fP pointer will be NULL or pointing to private memory you MUST NOT
  39 free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
  40 corresponding CURL handle.
  41 .SH PROTOCOLS
  42 RTSP
  43 .SH EXAMPLE
  44 .nf
  45 CURL *curl = curl_easy_init();
  46 if(curl) {
  47   CURLcode res;
  48   curl_easy_setopt(curl, CURLOPT_URL, "rtsp://rtsp.example.com");
  49   res = curl_easy_perform(curl);
  50   if(res == CURLE_OK) {
  51     char *id;
  52     curl_easy_getinfo(curl, CURLINFO_RTSP_SESSION_ID, &id);
  53   }
  54   curl_easy_cleanup(curl);
  55 }
  56 .fi
  57 .SH AVAILABILITY
  58 Added in 7.20.0
  59 .SH RETURN VALUE
  60 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  61 .SH "SEE ALSO"
  62 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "