Connected Property

Triggers a connection or disconnection.

Syntax

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected); Unicode (Windows) BOOL GetConnected();
INT SetConnected(BOOL bConnected);
@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;
- (BOOL)connected;
- (void)setConnected:(BOOL)newConnected;
#define PID_SFTP_CONNECTED 1

IPWORKSEDI_EXTERNAL void* IPWORKSEDI_CALL IPWorksEDI_SFTP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_SFTP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

FALSE

Remarks

This property triggers a connection or disconnection. Setting this property to True makes the class attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection. How and when the connection is closed is controlled by the Linger property.

This property is not available at design time.

Data Type

Boolean

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