curl_easy_setopt

[funkcja] Ustawia opcję sesji dla przekazanego uchwytu sesji CURL.

Składnia

#include <curl/curl.h>

CURLcode curl_easy_setopt( CURL * handle, CURLoption option, parameter );

Argumenty

Argument	Opis
CURL *handle	Uchwyt do sesji dla której ma zostać ustawiona określona opcja sesji CURL.
CURLoption option	Opcja sesji, która ma zostać ustawiona. Więcej informacji w dokumencie _{» curl ♦}CURLoption.
parameter	Wartość jaka ma zostać nadana dla opcji sesji, która została wskazana poprzez drugi argument niniejszej funkcji.

Zwracana wartość

Zwraca wartość CURLE_OK w przypadku sukcesu, tj. gdy udało się pomyślnie ustawić opcję sesji. Funkcja zwraca wartość różną od CURLE_OK w przypadku wystąpienia błędu. Więcej informacji o zwracanych błędach znajdziesz w dokumencie _{» curl ♦}CURLcode.

W przypadku gdy będziesz próbował ustawić opcję o której biblioteka curl nie wie to wówczas funkcja zwróci wartość CURLE_FAILED_INIT.

Opis szczegółowy

Funkcja ustawia opcję sesji dla przekazanego uchwytu sesji CURL. Uchwyt przekazany poprzez argument handle musi być stworzony przy pomocy funkcji _{» curl ♦}curl_easy_init lub _{» curl ♦}curl_easy_duphandle.

Za pomocą jednego wywołania funkcji można ustawić tylko i wyłącznie jedną opcję. Typowa aplikacja posiada wiele wywołań funkcji curl_easy_setopt na etapie konfiguracyjnym sesji.

Opcje ustawione za pomocą niniejszej funkcji są poprawne dla wszystkich wykonywanych operacji na określonym uchwycie sesji. Opcje nie są resetowane pomiędzy kolejnymi przesłaniami plików więc jeżeli chcesz wykonywać transfery plików z innymi opcjami to musisz je zmienić pomiędzy kolejnymi wywołaniami funkcji _{» curl ♦}curl_easy_perform. Możliwe jest również zresetowanie wszystkich opcji do stanu pierwotnego biblioteki curl przy pomocy funkcji _{» curl ♦}curl_easy_reset.

Dodatkowe informacje

Za pomocą funkcji curl_easy_setopt określa się zachowanie sesji CURL. Poprzez użycie odpowiednich opcji sesji określa się zachowanie biblioteki curl. Wszystkie opcje sesji ustawia się przy pomocy niniejszej funkcji.

Wartość opcji (czyli argument o nazwie parameter) może być zarówno liczbą całkowitą typu long, wskaźnikiem na funkcję, wskaźnikiem na obiekt bądź strukturą curl_off_t. Typ argumentu parameter jest zależny od wartości argumentu option.

Należy przeczytać uważnie dokumentację ponieważ przekazywanie złych wartości wejściowych może wywoływać niepożądane zachowanie biblioteki curl.

Łańcuchy znaków przekazywane poprzez argument funkcji są typu

char *

i są one kopiowane przez bibliotekę curl.

Uwaga!
Przed wersją 7.17.0 biblioteki curl łańcuchy znaków nie były kopiowane. W związku z powyższym użytkownik był zmuszony do trzymania przekazanych łańcuchów znaków tak długo jak biblioteka curl z nich korzystała.

Zagadnienia powiązane

curl_easy_reset	Resetuje stan wszystkich opcji dla podanego uchwytu sesji CURL. (funkcja)
CURLoption	Opcje sesji do konfiguracji sesji CURL. (typ wyliczeniowy)
CURLcode	Kody błędów zwracane przez funkcje biblioteki CURL. (typ wyliczeniowy)

Linki zewnętrzne

http://curl.haxx.se/libcurl/c/curl_easy_setopt.html

Wszystkie teksty są chronione prawami autorskimi. Kopiowanie lub rozpowszechnianie treści poza niniejszym serwisem jest zabronione.

Powyższe ograniczenie nie dotyczy autora opracowania, któremu przysługuje prawo do rozpowszechniania własnego tekstu wedle własnego uznania.