XMapToolsAreXMapLayersAvailable Method |
Checks if one or n certain layers are available or not.
Namespace:
Ptv.XServer.Controls.Map.Tools
Assembly:
Ptv.XServer.Controls.Map (in Ptv.XServer.Controls.Map.dll) Version: 1.7.10.0
Syntax public static bool AreXMapLayersAvailable(
string url,
string contextKey,
Layer[] layers,
string profile,
string expectedErrorCode,
string xServerUser = null,
string xServerPassword = null
)
Public Shared Function AreXMapLayersAvailable (
url As String,
contextKey As String,
layers As Layer(),
profile As String,
expectedErrorCode As String,
Optional xServerUser As String = Nothing,
Optional xServerPassword As String = Nothing
) As Boolean
public:
static bool AreXMapLayersAvailable(
String^ url,
String^ contextKey,
array<Layer^>^ layers,
String^ profile,
String^ expectedErrorCode,
String^ xServerUser = nullptr,
String^ xServerPassword = nullptr
)
static member AreXMapLayersAvailable :
url : string *
contextKey : string *
layers : Layer[] *
profile : string *
expectedErrorCode : string *
?xServerUser : string *
?xServerPassword : string
(* Defaults:
let _xServerUser = defaultArg xServerUser null
let _xServerPassword = defaultArg xServerPassword null
*)
-> bool
Parameters
- url
- Type: SystemString
The url to the XMap instance. - contextKey
- Type: SystemString
The used context key or null if none is used. - layers
- Type: xserverLayer
The layers to check. - profile
- Type: SystemString
The profile used to check the availability. - expectedErrorCode
- Type: SystemString
The expected error code if the at least one layer does not exist.
SoapExceptions carrying this error code will be caught and the return value of the method will be false.
SoapExceptions carrying another error code will not be caught and thus be thrown by this API.
- xServerUser (Optional)
- Type: SystemString
User name needed for Azure Cloud. - xServerPassword (Optional)
- Type: SystemString
Password needed for Azure Cloud.
Return Value
Type:
BooleanTrue if one or n layers are available, false if at least one layer is not available.
May throw exceptions in case of malformed url or wrong contextKey definition.
See Also