Sdk dns api documentation

Dns functions.

Namespace: dmDNS
Include: #include <dmsdk/dlib/dns.h>
ENUMS
dmDNS::Result result type
FUNCTIONS
 dmDNS::NewChannel(dmDNS::HChannel* channel) create a new channel
void dmDNS::StopChannel(dmDNS::HChannel channel) stop current request
void dmDNS::DeleteChannel(dmDNS::HChannel channel) delete channel
 dmDNS::RefreshChannel(dmDNS::HChannel channel) refresh to the latest dns servers

Functions

dmDNS::NewChannel

 dmDNS::NewChannel(dmDNS::HChannel* channel)

Creates a new channel that can be used for DNS queries.

PARAMETERS

dmDNS::HChannel* channel Pointer to the created channel if successful, will be left alone otherwise

RETURNS

on succcess

dmDNS::StopChannel

void dmDNS::StopChannel(dmDNS::HChannel channel)

Stops the current request (if available) on a channel.

PARAMETERS

dmDNS::HChannel channel Handle to the channel

dmDNS::DeleteChannel

void dmDNS::DeleteChannel(dmDNS::HChannel channel)

Deletes the current channel and cancels all requests. Note: You must always make sure to call StopChannel(channel) before calling this function.

PARAMETERS

dmDNS::HChannel channel Handle to the channel

dmDNS::RefreshChannel

 dmDNS::RefreshChannel(dmDNS::HChannel channel)

Refreshes the channel configuration so that the latest DNS servers are used.

PARAMETERS

dmDNS::HChannel channel Handle to the channel

RETURNS

on succcess

Enums

dmDNS::Result

result type

Result type

dmDNS::RESULT_OK 0
dmDNS::RESULT_INIT_ERROR -1
dmDNS::RESULT_HOST_NOT_FOUND -2
dmDNS::RESULT_CANCELLED -3
dmDNS::RESULT_UNKNOWN_ERROR -4