SDK DNS API documentation

Version: alpha

FUNCTION
dmDNS::DeleteChannel()

delete channel

dmDNS::NewChannel()

create a new channel

dmDNS::RefreshChannel()

refresh to the latest dns servers

dmDNS::StopChannel()

stop current request

ENUMS
dmDNS::Result

result type

Functions

dmDNS::DeleteChannel()

dmDNS::DeleteChannel(channel)

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

PARAMETERS

channel

dmDNS::HChannel Handle to the channel


dmDNS::NewChannel()

dmDNS::NewChannel(channel)

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

PARAMETERS

channel

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

RETURNS

RESULT_OK

on succcess


dmDNS::RefreshChannel()

dmDNS::RefreshChannel(channel)

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

PARAMETERS

channel

dmDNS::HChannel Handle to the channel

RETURNS

RESULT_OK

on succcess


dmDNS::StopChannel()

dmDNS::StopChannel(channel)

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

PARAMETERS

channel

dmDNS::HChannel Handle to the channel


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