TCPIP_SMTP_UsageBegin Function

C

bool TCPIP_SMTP_UsageBegin();

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 TCPIP_SMTP_UsageEnd() 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.

Returns

None.

Remarks

None.