IRAPISession::CeGetWindow

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves the handle to a window that has the specified relationship to the specified window on a remote Windows Embedded CE–based device.

Syntax

HWND CeGetWindow( 
  HWND hWnd, 
  UINT uCmd 
);

Parameters

• hWnd
  Handle to a window. The window handle retrieved is relative to this window, based on the value of the uCmd parameter.

• uCmd
  Specifies the relationship between the specified window and the window whose handle is to be retrieved. This parameter can be one of the following values.

  Value	Description
  GW_CHILD	The retrieved handle identifies the child window at the top of the z-order, if the specified window is a parent window; otherwise, the retrieved handle is NULL. The function examines only child windows of the specified window. It does not examine descendant windows.
  GW_HWNDFIRST	The retrieved handle identifies the window of the same type that is highest in the z-order. If the specified window is a topmost window, the handle identifies the topmost window that is highest in the z-order. If the specified window is a child window, the handle identifies the sibling window that is highest in the z-order.
  GW_HWNDLAST	The retrieved handle identifies the window of the same type that is lowest in the z-order. If the specified window is a topmost window, the handle identifies the topmost window that is lowest in the z-order. If the specified window is a child window, the handle identifies the sibling window that is lowest in the z-order.
  GW_HWNDNEXT	The retrieved handle identifies the window below the specified window in the z-order. If the specified window is a topmost window, the handle identifies the topmost window below the specified window. If the specified window is a child window, the handle identifies the sibling window below the specified window.
  GW_HWNDPREV	The retrieved handle identifies the window above the specified window in the z-order. If the specified window is a topmost window, the handle identifies the topmost window above the specified window. If the specified window is a child window, the handle identifies the sibling window above the specified window.
  GW_OWNER	The retrieved handle identifies the specified window's owner window, if any. This flag will not retrieve a parent window.

Return Value

A valid window handle indicates success. NULL indicates that no window exists with the specified relationship to the specified window. To get extended error information, call IRAPISession::CeGetLastError and IRAPISession::CeRapiGetError.

Remarks

This method distinguishes between only top-level and child windows. Topmost windows are considered top-level windows.

Requirements

See Also

Reference

IRAPISession
IRAPISession::CeGetWindowLong
IRAPISession::CeGetWindowText