SessionManagerCheckAPIVersion Method

Check compatibility between client version and server version

Definition

Namespace: FileHold.UserRoleManager
Assembly: FileHold.UserRoleManager (in FileHold.UserRoleManager.dll) Version: 17.1.0.0
C#
[WebMethodAttribute(Description = "Check compatibility between client version and server version")]
public int CheckAPIVersion(
	string sessionId,
	string clientVersion,
	ref string serverVersion
)

Parameters

sessionId  String
Optional session ID for logging client version.
clientVersion  String
Input: client's API version (as Major.Minor)
serverVersion  String
Output: server's API version (as Major.Minor)

Return Value

Int32
* APIVersion.Compatible.Yes - versions are fully compatible * APIVersion.Compatible.Partially - server is newer but backward compatible, display a warning message * APIVersion.Compatible.No - server is too old and not compatible, display an error message

See Also