wodSFTP API library - ProxyPassword Property
      
 

Description

Specifies the password to use when connecting to a proxy server.


Return type

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


Syntax

long Sftp_GetProxyPassword(void *Sftp, char *Buffer, int *Bufsize);
long Sftp_SetProxyPassword(void *Sftp, char *newVal);

The ProxyPassword function syntax has these parts:

Part Description
void *Sftp Handle of the created Sftp instance.
char *Buffer Buffer that will hold the returned string.
int *Bufsize Size 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.