StartIdle Method

Begins idling.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int StartIdle();

Unicode (Windows)
INT StartIdle();

- (void)startIdle;

#define MID_PIMAP_STARTIDLE 37

IPWORKSOPENPGP_EXTERNAL int IPWORKSOPENPGP_CALL IPWorksOpenPGP_PIMAP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method sends the IDLE command to the server and begins idling. As responses are received from the server the IdleInfo event fires. To stop idling call StopIdle.

If the class is being used in a formless application (such as a console application) be sure to call DoEvents in a loop after calling this method to make sure incoming events are processed.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)