Developer

API Reference

ISockPort_GetOpt()

Brew Release
Brew MP 1.0.2
See Also
None.
Description
Gets options for a socket.
Parameters
  • po
    []:
    [in] pointer to the ISockPort interface
  • nLevel
    []:
    [in] option level (see AEESockOpt)
  • nOptName
    []:
    [in] option name (see AEESockOpt)
  • pOptVal
    []:
    [out] pointer to the data type appropriate for the option (see AEESockOpt)
  • pnOptSize
    []:
    [in/out] on input, pnOptSize specifies the size of pOptVal in bytes. On output, pnOptSize is set to the number of data bytes filled into pOptVal.
Interface
Prototype
   int ISockPort_GetOpt(ISockPort* po, int nLevel, int nOptName, void *pOptVal, int* pnOptSize)
Return
AEE_SUCCESS: The socket option has been successfully retrieved.
IPORT_WAIT: Operation in progress; use ISockPort_Readable() to be notified when to try again.
AEE_NET_EFAULT : invalid parameter has been specified AEE_NET_EINVAL : invalid socket AEE_NET_EBADF : socket is not open AEE_NET_ENOPROTOOPT: the option is unknown at the level indicated AEE_NET_EOPNOTSUPP : not supported on this socket type AEE_NET_ENETDOWN : network is not available (handset has lost network coverage) AEE_NET_EMFILE : not enough resources to complete this operation (too many sockets are in use).
Other error codes are also possible.
Side Effect
None.
Comment
None.
  • Follow