Back to product page

ClientName function


Determines client name that will be used with the server during initial exchange.

Type

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

Syntax

  • C
long Sftp_GetClientName(void *Sftp, char *Buffer, int *Bufsize);
long Sftp_SetClientName(void *Sftp, char *newVal);
The ClientName(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. Represents the client name sent to the server.
int *Bufsizeint *Bufsize

Remarks

Prior to issuing Connect method, using ClientName property you can set custom client name that will be used with remote server. It may show in server logs as type of the client during initial negotiation.

NOTE: you cannot change this property in DEMO version.

Platforms

Windows