SFTPConnectionConnected Property

Used to disconnect individual connections and/or show their status.

Syntax

ANSI (Cross Platform)
int GetSFTPConnectionConnected(int iConnectionId);
int SetSFTPConnectionConnected(int iConnectionId, int bSFTPConnectionConnected); Unicode (Windows) BOOL GetSFTPConnectionConnected(INT iConnectionId);
INT SetSFTPConnectionConnected(INT iConnectionId, BOOL bSFTPConnectionConnected);
- (BOOL)SFTPConnectionConnected:(int)connectionId;
- (void)setSFTPConnectionConnected:(int)connectionId:(BOOL)newSFTPConnectionConnected;
#define PID_SFTPSERVER_SFTPCONNECTIONCONNECTED 3

IPWORKSSFTP_EXTERNAL void* IPWORKSSFTP_CALL IPWorksSFTP_SFTPServer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTPServer_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTPServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

FALSE

Remarks

Used to disconnect individual connections and/or show their status.

The SFTPConnectionConnected is used to close connections.

SFTPConnectionConnected also shows the status of a particular connection (connected/disconnected).

How and when the connection is closed is controlled by the Linger property. Please refer to its description for more information.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

This property is not available at design time.

Data Type

Boolean

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8162]