SMTPBeginUsage Function

Microchip TCP/IP Stack

Microchip TCP/IP Stack Help
SMTPBeginUsage Function
C
BOOL SMTPBeginUsage();
Description

Call this function before calling any other SMTP Client APIs. This function obtains a lock on the SMTP Client, which can only be used by one stack application at a time. Once the application is finished with the SMTP client, it must call SMTPEndUsage to release control of the module to any other waiting applications. 

This function initializes all the SMTP state machines and variables back to their default state.

Preconditions

None

Return Values
Return Values 
Description 
TRUE 
The application has successfully obtained control of the module 
FALSE 
The SMTP module is in use by another application. Call SMTPBeginUsage again later, after returning to the main program loop 
Microchip TCP/IP Stack 5.42.08 - June 15, 2013
Copyright © 2012 Microchip Technology, Inc.  All rights reserved.