OFTPConnectionConnected Property

This property is used to disconnect individual connections and/or show their status.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetOFTPConnectionConnected(int iConnectionId);
int SetOFTPConnectionConnected(int iConnectionId, int bOFTPConnectionConnected);

Unicode (Windows)
BOOL GetOFTPConnectionConnected(INT iConnectionId);
INT SetOFTPConnectionConnected(INT iConnectionId, BOOL bOFTPConnectionConnected);

- (BOOL)OFTPConnectionConnected:(int)connectionId;
- (void)setOFTPConnectionConnected:(int)connectionId:(BOOL)newOFTPConnectionConnected;

#define PID_OFTPSERVER_OFTPCONNECTIONCONNECTED 9

IPWORKSEDI_EXTERNAL void* IPWORKSEDI_CALL IPWorksEDI_OFTPServer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_OFTPServer_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_OFTPServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

FALSE

Remarks

This property is used to disconnect individual connections and/or show their status.

The OFTPConnectionConnected property may be set to false to close the connection.

OFTPConnectionConnected 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 OFTPConnectionCount property.

This property is not available at design time.

Data Type

Boolean