DisplayClaim

Top  Previous  Next

Message

 

DisplayClaim <devicenumber> [-alias <newalias>]

DisplayClaim <devicegroup> <devicename> [-alias <newalias>]

 

Originator

 

Client

 

Response

 

SyntaxError: insufficient parameters to DisplayClaim

SyntaxError: invalid parameters to DisplayClaim

Error: device number isn't a number!

ClaimAccepted: <devicenumber>

Error: alias is blank

Error: can't have spaces in an alias

Error: aliases can't begin with a digit

Error: alias already exists

ClaimAccepted: <devicenumber> (alias not set)

ClaimRejected: <devicenumber> is a non-existent display device

ClaimRejected: display device <devicenumber> is already claimed

ClaimRejected: group/device <devicegroup>/<devicenumber> not recognized

Info: new alias created for server-owned display device <devicenumber>

 

Response (immediate socket)

 

Success

Failure

 

Details

 

Immediate socket returns success only if (1) the device is claimed; and (2) if an alias was specified, that the alias was instantiated successfully.

 

Server device names. If you use the second form of the command, the device specified by the combination of the devicegroup and devicename parameters is claimed.        

 

Revision history

 

Implemented by WhiskerServer version 2.3.

 

See also

 

Display devices
Device names and aliases
DisplaySetAlias
DisplayRelinquishAll