tfPop3UserSetSockOpt
Table of Contents >> Optional Protocols >> POP3
#include <trsocket.h> |
int tfPop3UserSetSockOpt | ( |
ttPop3ClientHandle pop3Handle, | |
u_char family, | |
int protocolLevel, | |
int optionName, | |
const char TM_FAR *optionValuePtr, | |
int optionLength | |
); |
Function Description
This function sets the requested option for the socket associated with the given POP3 handle.
Parameters
- pop3Handle
- This is set to the pop3Handle for which socket options should be set..
- family
- This is set to the protocol family (AF_INET or AF_INET6))
- protocolLevel
- This is analogous to the protocolLevel for setsockopt.
- optionName
- This is analogous to the optionName for setsockopt
- optionValuePtr
- This is analogous to the optionValuePtr for setsockopt
- optionLength
- This is analogous to the optionLength for setsockopt
Returns
- TM_EINVAL
- This indicates failure. The kernel found invalid arguments in the call.
- TM_ENOERROR.
- This indicates success
- Other values
- Other error values indicate various forms of failure which are from socket or setsockopt calls.