Back to product page

ProxyPassword function


Specifies the login/username to use when connecting to a proxy server.

Type

A Long value. If successful, 0 is returned, otherwise error as specified here

Syntax

  • C
long Sftp_GetProxyPassword(void *Sftp, char *Buffer, int *Bufsize);
long Sftp_SetProxyPassword(void *Sftp, char *newVal);
The ProxyPassword(void *Sftp,char *Buffer,int *Bufsize) syntax has these parts:
void *SftpHandle of the created Sftp instance.
char *BufferBuffer that will hold the returned string.
int *BufsizeSize of the buffer.

Remarks

Only Socks 5, ProxyWEBStandard and ProxyWEBNtlmAuth proxies support passwords when connecting to a proxy server. On all other proxy types, this function is ignored.

The Bufsize variable should contain the maximum data length that can be stored in the Buffer variable. If you set Bufsize = 0, then the function will return with error ERROR_INSUFFICIENT_BUFFER and Bufsize will contain the required buffer size.

Platforms

Windows