Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Gets the starting position of the field field (of any type) at the specified screen position.

Namespace:  JollyGiant.Emulation
Assembly:  JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


C#
[ComVisibleAttribute(true)]
public StatusCode GetPosition(
	ref ScreenPosition position
)


Visual Basic (Declaration)
<ComVisibleAttribute(True)> _
Public Function GetPosition ( _
	ByRef position As ScreenPosition _
) As StatusCode


Visual C++
[ComVisibleAttribute(true)]
public:
virtual StatusCode GetPosition(
	ScreenPosition% position
) sealed


JavaScript
function GetPosition(position);


Parameters

position
Type: JollyGiant.Emulation..ScreenPosition
Position inside the field for which to retrieve the starting ScreenPosition.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:


Status codeDescription
WHLLOKThe specified field position was found.
WHLLNOTCONNECTEDYour application is not currently connected to a host session.
WHLLPARAMETERERROROne or more of the call parameters are invalid.
WHLLPOSITIONERRORThe screen position specified is invalid.
WHLLSYSERRORThe method failed due to a system error.
WHLLNOFIELDThe specified field was not found, or the session presentation space is unformatted.
WHLLZEROLENFIELDThe specified field has a length of zero.


Implements

IField..GetPosition(ScreenPosition)

Remarks

The starting position of a IField is defined as the position of it's attribute byte.

See Also

Send comments on this topic to: Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.