Routines (alphabetical) > Object Classes > Network Object Classes > IDLnetOGCWMS Properties

# IDLnetOGCWMS Properties

IDLnetOGCWMS objects have the following properties. Properties with the word “Yes” in the “Init” column of the property table can be set via IDLnetOGCWMS::Init.

Note: For a discussion of the property description tables shown below, see About Object Property Descriptions.

Objects of this class have the following properties.

AUTHENTICATION CALLBACK_DATA CALLBACK_FUNCTION CAPABILITIES_FILENAME CONNECT_TIMEOUT CONTENT_TYPE ENCODE FEATURE_INFO_FILENAME HEADERS LAST_FILE MAP_FILENAME PASSWORD PROXY_AUTHENTICATION PROXY_HOSTNAME PROXY_PASSWORD PROXY_PORT | PROXY_USERNAME RESPONSE_HEADER SSL_CERTIFICATE_FILE SSL_VERIFY_HOST SSL_VERIFY_PEER TIMEOUT URL_HOSTNAME URL_PATH URL_PORT URL_QUERY_PREFIX URL_QUERY_SUFFIX URL_SCHEME USERNAME VERBOSE WMS_VERSION

### AUTHENTICATION

This property specifies the type of authentication used when connecting to an OGC server. Supported authentication modes are:

Type | Integer
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### CALLBACK_DATA

This property contains data that is to be passed to the function defined by the CALLBACK_FUNCTION property when a callback is initiated. The data contained in the variable is defined and set by the caller. When a callback is initiated, this data is passed, unmodified, directly to callback function. Data can be of any type supported by IDL variables including numerical, string, pointer and structure data. If this property is not set, the GetCapabilities, GetMap, and GetFeatureInfo methods will pass the integer value zero to the callback function.

Type | Any IDL variable
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### CALLBACK_FUNCTION

This property is the name of the .`pro` code function to be called when GetCapabilities, GetMap, and GetFeatureInfo methods are retrieving information from the remote server. The function provides status information in addition to providing a way to cancel an operation. If this property is not set, then no callbacks will be made by the previously noted methods. See Using Callbacks with the IDLnetOGCWMS Object for more information.

The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### CAPABILITIES_FILENAME

The IDLnetOGCWCS::GetCapabilities method returns and stores an XML file that contains information about the layers available on the remote server. Set this property to define the path and filename of this file, minus the extension. The file type extension is automatically set based on the type of file downloaded (typically .xml). If this property stays the same between calls to GetCapabilities, the last file received is overwritten.

This property defaults to a file named cap, located in your application user directory. If a file was returned by the most recent call to the GetCapabilities method, the LAST_FILE property will contain the full path and filename of the downloaded file.

Note: Do not include a file type extension in the filename. If the retrieved file does not have the same extension as that given, the name will be appended with the file type extension of the received file (but this property will remain unchanged). For example, if you include the .`xml` extension (`cap.xml`) and the file received is an HTML file, the filename of the file on disk will be `cap.xml.html`, while this property remains `cap.xml`. Always omit the file type extension to avoid such inconsistencies.

This property cannot be set to an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### CONNECT_TIMEOUT

This property controls how long to wait for a successful connection to an OGC server before ending the attempt to establish a connection. The default is 180 seconds.

Type | Integer
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### CONTENT_TYPE

This property indicates the document type of the last file received. The value of this property is extracted from the Content-Type field of an HTTP response header.

Type | String
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### ENCODE

This property determines if a compressed or encoded response will be requested from a remote OGC WMS server (during GetCapabilities, GetMap, and GetFeatureInfo method calls). By default, the IDLnetOGCWMS object requests an unencoded response (ENCODE=0) in order to reduce the number of bytes that need to be sent over the network.

Note: The server does not have to respond with compressed or encoded data. You can determine the encoding, if any, by examining the “Content-Encoding” header in the response. See the VERBOSE property for information on how to access such information.

Allowable values are:

Value | Description
0 | No encoding—do not request an encoded response. If the server sends a compressed or encoded response even though this was not requested, the response will not be decompressed or decoded and the output file will be written with the compressed or encoded data. This is the default
1 | DEFLATE encoding — request and accept DEFLATE encoding. If the server replies with an encoded response, the data is decompressed or decoded before being written to the output file.
2 | GZIP encoding — request and accept GZIP encoding. If the server replies with an encoded response, the data is decompressed or decoded before being written to the output file.
3 | DEFLATE and GZIP encoding — request and accept both types of encoded responses. If the server replies with an encoded response, the data is decompressed or decoded before being written to the output file.

Type | Integer
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### FEATURE_INFO_FILENAME

The IDLnetOGCWMS::GetFeatureInfo method returns and stores a feature file from the WMS server. Set this property to define the path and filename of this file, minus the extension. The file type extension is automatically set based on the type of file downloaded. If this property stays the same (the path and filename are unchanged, and the same type of file is retrieved) between calls to GetFeatureInfo, the last file received is overwritten.

This property defaults to a file named feature, located in your application user directory. If a file was returned by the most recent call to the GetFeatureInfo method, the LAST_FILE property will contain the full path and filename of the downloaded file.

Note: Do not include a file type extension in the filename. If the retrieved file does not have the same extension as that given, the name will be appended with the file type extension of the received file (but this property will remain unchanged). For example, if you include the .`txt` extension (`feature.txt`) and the file received is an `.html` file, the filename of the file on disk will be `feature.txt.html`, while this property remains `feature.txt`. Always omit the file type extension to avoid such inconsistencies.

This property cannot be set to an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### HEADERS

Note: This property is set automatically and need not be modified unless you have specific HTTP header information that you want included in a GET request sent to a remote WMS server.

Note: This property is automatically set to the default value (clearing any custom header information) after a call to any IDLnetOGCWMS::Get* method except GetProperty. Clearing the HEADERS property prevents the inadvertent use of custom header values in future calls to Get methods.

Set this property to a string or array of strings containing one or more valid header fields and values separated by a colon. Each string in the string array should contain a single header field.

The HTTP header Host, Accept and Encode fields are set by default. To add, disable or modify headers, do one of the following:

- Add a custom header by setting this property equal to a string containing a valid header field and value or a string array containing multiple strings. This property can be called multiple times to append additional header fields to the list of existing custom header items.
- Disable an existing header by setting the HTTP header field name equal to no value (no data on the right side of the colon). For example, `HEADERS=`"`Accept:`" disables the header field.
- Add a header without contents by setting a header field equal to an empty string. For example, `HEADERS="Accept:''"` clears the field contents.

Set this property to an empty string to clear all custom headers and reset default values if appropriate. For example, `HEADERS=''` clears all custom changes.

Note: This method cannot be used to modify the first method line of a HTTP request (typically GET or POST).

Retrieving this property will return only those headers set using this method. Use the VERBOSE keyword to see the default header information included in a request.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### LAST_FILE

This property contains the full path and filename of the file retrieved from the last successful call to one of the GetCapabilities, GetFeatureInfo, or GetMap methods. If the most recent call did not return a file, this property will contain an empty string. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### MAP_FILENAME

The IDLnetOGCWMS::GetMap method returns and stores a map file containing the layers requested from the WMS server. Set this property to define the path and filename of this file, minus the extension. The file type extension is automatically set based on the type of file downloaded. If this property stays the same (the path and filename are unchanged, and the same type of file is retrieved) between calls to GetMap, the last file received is overwritten.

This property defaults to a file named `map`, located in your application user directory. If a file was returned by the most recent call to the GetMap method, the LAST_FILE property will contain the full path and filename of the downloaded file.

Note: Do not include a file type extension in the filename. If the retrieved file does not have the same extension as that given, the name will be appended with the file type extension of the received file (but this property will remain unchanged). For example, if you include the .`tiff` extension (`cov.tiff`) and the file received is a `.gml` file, the filename of the file on disk will be `cov.tiff.gml`, while this property remains `cov.tiff`. Always omit the file type extension to avoid such inconsistencies.

This property cannot be set to an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### PASSWORD

This property contains the password required for successful authentication with a secure WMS server. The default value is an empty string.

Type | String
Name String | not displayed
Get: No | Set: Yes | Init:Yes | Registered: No

### PROXY_AUTHENTICATION

This property specifies the type of authentication that will be used when connecting to a proxy server. Supported authentication modes are:

Type | Integer
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### PROXY_HOSTNAME

This property specifies the hostname or IP address of the proxy server. This property must be set when connecting to an intranet or the internet through a proxy server. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### PROXY_PASSWORD

This property contains the password required for successful authentication with a secure proxy server. The default value is an empty string.

Type | String
Name String | not displayed
Get: No | Set: Yes | Init:Yes | Registered: No

### PROXY_PORT

This property specifies the TCP/IP port that the proxy server listens to for incoming requests. The default value is “80”, the standard port for an HTTP request. This property must be set when connecting to an intranet or the internet through a proxy server.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### PROXY_USERNAME

This property contains the username required for successful authentication with a secure proxy server. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### RESPONSE_HEADER

This read-only property contains the HTTP response header from the last request made to an OGC WMS server. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: No | Init:No | Registered: No

### SSL_CERTIFICATE_FILE

Set this property to the full path and filename of the file containing one or more certificates to be verified with the peer when communicating with a secure server. The default location is `IDL_DIR``/bin/bin.``platform` directory where `IDL_DIR` is your IDL installation directory. A default bundle of Certificate Authority (CA) certificates is installed in this location. Use this property to specify the location of an alternate certificate file.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### SSL_VERIFY_HOST

When negotiating a SSL connection, the server sends a certificate indicating its identity. Use this property to determine whether you have connected to the expected server as follows:

Type | Boolean
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### SSL_VERIFY_PEER

SSL peer authentication depends on verification of a chain of digital signatures contained in one or more Certificate Authority (CA) certificates. See SSL_CERTIFICATE_FILE for information on the default CA certificates installed with IDL and how to supply your own certificates.

Type | Boolean
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### TIMEOUT

This property controls how long to wait for the transmission from the OGC server to complete before ending the attempt. The default is 1800 seconds.

Type | Integer
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### URL_HOSTNAME

This property specifies the host name or IP address of the remote OGC WMS server.

Note: This property and the URL_PATH property must be set before calling GetCapabilities, GetMap, or GetFeatureInfo. The hostname and path elements are integral components of the request that is sent to the WMS server.

You can either set this property manually or pass a URL to the IDLnetOGCWMS::ParseUrl method. See Translating a URL into Property Values for more information. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### URL_PATH

This property specifies the path to the remote OGC WMS server.

Note: This property and the URL_HOSTNAME property must be set before calling GetCapabilities, GetMap, or GetFeatureInfo. The path and hostname elements are integral components of the request that is sent to the WMS server.

You can either set this property manually or pass a URL to the IDLnetOGCWMS::ParseUrl method. See Translating a URL into Property Values for more information. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### URL_PORT

This property specifies the TCP/IP port at which the remote server listens for incoming requests. You can either set this property manually or pass a URL to the IDLnetOGCWCS::ParseUrl method. See Translating a URL into Property Values for more information. The default value is “80”, the standard port for an HTTP request.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### URL_QUERY_PREFIX

This property specifies a prefix containing additional query information that will be prepended to the main portion of a request. You can either set this property manually or pass a URL to the IDLnetOGCWMS::ParseUrl method. See Translating a URL into Property Values for more information. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### URL_QUERY_SUFFIX

This property specifies a suffix containing additional query information that will be appended to the main portion of a request. See Translating a URL into Property Values for more information on this property. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### URL_SCHEME

This property specifies the name of the protocol used to communicate with the remote WMS server when a request is made. You can either set this property manually or pass a URL to the IDLnetOGCWCS::ParseUrl method. See Translating a URL into Property Values for more information. Possible values are:

String Value | Description
http | This is the default.
https | Use this setting when making a secure request and Secure Socket Layer (SSL) is supported by the remote WMS server. See SSL_CERTIFICATE_FILE, SSL_VERIFY_HOST, and SSL_VERIFY_PEER for SSL-related configuration parameters.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### USERNAME

This property contains the username required for successful authentication with a secure WMS server. The default value is an empty string.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

### VERBOSE

Set this property to a non-zero value to return verbose connection and HTTP header information associated with an IDLnetOGCWMS::GetCapabilities, IDLnetOGCWMS::GetMap, or IDLnetOGCWMS::GetFeatureInfo method request. By default, this property is set to zero, and only standard information is returned.

To access this information, the CALLBACK_FUNCTION property must also be set. The callback function’s StatusInfo variable will contain:

- Messages about the TCP/IP connection to the remote server
- Messages about the HTTP header fields being sent to the remote server
- Messages about the HTTP header fields received from the remote server

Each message is limited to 512 bytes of text.

Type | Boolean
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No

Note: For a simple example of using a callback to return VERBOSE status information, see IDLnetOGCWMS::GetLayers.

### WMS_VERSION

This property defines the version of the OGC WMS standard supported by the IDLnetOGCWMS object. The default value is “Version=1.1.1” but “Version=1.3.0” is also an allowable value.

Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init:Yes | Registered: No