Move Window by User (QsnMovWinUsr) API

The Move Window by User (QsnMovWinUsr) API allows a window to be moved on the screen to a new location specified by the user. The API positions the cursor at the upper left corner of the window and prompts the user to move the cursor to the new position for the upper left corner. The prompt is displayed only if a message line has been defined. If the window can fit within the display at the location specified, it is moved to the new position. If a Change Window Coordinates exit routine is specified on the window description, it is called after the window is successfully moved. If the window is a full screen window, the API will complete successfully, but the window will not be moved.

Authorities and Locks

None

Required Parameter

Window handle

INPUT; BINARY(4)

A handle for the window to be moved.

Omissible Parameter

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.

Returned Value

Return code

OUTPUT; BINARY(4)

A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.

Error Messages