Get_Url_List - AMX NETLINX PROGRAMMING LANGUAGE Manual

Reserved Identifiers
Keywords & Run-Time Library Functions (Cont.)

GET_URL_LIST

132
This function returns a list of URLs that the specified device is programmed to
actively attempt to connect to. The function requires an array of URL_STRUCT
Structures that will get filled in with the device's URL list.
SLONG Get_URL_List(DEV Device,URL_STRUCT
UrlList[ ],INTEGER Type )
Parameters:
• Device: Device number of the device from which the URLs will be retrieved.
Typically, they are stored on the local master (0:1:0), but if you are currently
connected to another master your can use <0:1:system number of remote
master>.
• UrlList: Array of URL_STRUCTs that will receive the device's URLs
• Type: Indicates the type(s) of URLs desired-NetLinx language programmed,
IDE programmed, or both
1: All URLs
2: NetLinx programmed URLs
3: IDE programmed URLs
The function returns the number of URLs updated in the supplied array of
URL_STRUCTs.
-1: Specified device is invalid or is not online
-2: Request timed out
-3: Busy
URLs may be programmed by either the Integrated Development environment
or via the ADD_URL_ENTRY function. The Type parameter filters the list of URLs
so that only the desired URLs are returned in the URL_STRUCT(s). The function
requires an array of URL_STRUCTs.
The URL_STRUCT is predefined as follows:
STRUCTURE URL_STRUCT
{
CHAR Flags // Connection Type (normally 1)
INTEGER Port // TCP port (normally 1319)
CHAR URL[128] // string: URL or IP address
}
The following definitions exist for the Flags member of the URL_STRUCT struc-
ture.
CONSTANT CHAR URL_Flg_TCP = 1
connection
CONSTANT CHAR URL_Flg_TEMP = $10
CONSTANT CHAR URL_Flg_Stat_PrgNetLinx = $20 // URL set by
CONSTANT CHAR URL_Flg_Stat_Mask = $C0
CONSTANT CHAR URL_Flg_Stat_Lookup = $00
IP
CONSTANT CHAR URL_Flg_Stat_Connecting = $40 // connecting
CONSTANT CHAR URL_Flg_Stat_Waiting = $80
CONSTANT CHAR URL_Flg_Stat_Connected = $C0
NetLinx Programming Language Reference Guide
// TCP
// NetLinx
// ADD_URL_ENTRY
// status mask
// Looking up
// waiting
// connected