docs/libcurl/opts/CURLOPT_PORT.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 CURLOPT_PORT 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PORT \- set remote port number to work with
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PORT, long number);
  31 .SH DESCRIPTION
  32 This option sets \fInumber\fP to be the remote port number to connect to,
  33 instead of the one specified in the URL or the default port for the used
  34 protocol.
  35
  36 Usually, you just let the URL decide which port to use but this allows the
  37 application to override that.
  38
  39 While this option accepts a 'long', a port number is usually a 16 bit number
  40 and therefore using a port number over 65535 will cause a run-time error.
  41 .SH DEFAULT
  42 By default this is 0 which makes it not used.
  43 .SH PROTOCOLS
  44 Used for all protocols that speak to a port number.
  45 .SH EXAMPLE
  46 .nf
  47 CURL *curl = curl_easy_init();
  48 if(curl) {
  49   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  50   curl_easy_setopt(curl, CURLOPT_PORT, 8080L);
  51   ret = curl_easy_perform(curl);
  52   curl_easy_cleanup(curl);
  53 }
  54 .fi
  55 .SH AVAILABILITY
  56 Always
  57 .SH RETURN VALUE
  58 Returns CURLE_OK
  59 .SH "SEE ALSO"
  60 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "