Home · All Commands · First Steps · Tutorials · Demos · FAQ
 

Remote Interface Documentation

Variables

BlockUserInteraction: Block user interaction

Variables

const UINT RI_MESSAGE_BLOCKUSERINTERACTION = RegisterWindowMessage(TEXT("RI_MESSAGE_BLOCKUSERINTERACTION"))

Variable Documentation

const UINT RI_MESSAGE_BLOCKUSERINTERACTION = RegisterWindowMessage(TEXT("RI_MESSAGE_BLOCKUSERINTERACTION"))

Message ID for the Request "block user interaction":
RI_MESSAGE_BLOCKUSERINTERACTION

Write Memory:

This function has no writer.

Read Memory:

This function has no reader.

Return Values for BlockUserInteraction:

RI_NOERROR = BlockUserInteraction succeeded. errorcode (0)

Description:

Disables the user interaction (mouse and key) with the navigator.
To enable the user input, see AllowUserInteraction.

Example:

#define USE_LOADLIBRARY
#include "TNSRemoteInterfaceDll.h"

LPARAM GetUniqueID()
{
    //generate unique ID
    static LPARAM id = 0;
    if (++id == 0) ++id; // do not use 0 !!!!!
    return id;
}

inline LRESULT RI_MESSAGE( const UINT request, HWND h_client, LPARAM id )
{
    //check if RI handle is valid
    if ( !IsWindow( RI_GetTNS() ) ) 
        return RI_NAVIGATIONNOTACTIVE;
    //send the request
    PostMessage( RI_GetTNS(), request, WPARAM(h_client), id );
    return RI_NOERROR;
}

LRESULT CDlgMFC_BlockUserInteraction::WindowProc ( UINT  message , WPARAM  wParam , LPARAM  lParam )
{
    //check messages for answer from RI
    if ( message == RI_MESSAGE_BLOCKUSERINTERACTION )
    {
        if ( (LRESULT)wParam == RI_NOERROR )
            //BlockUserInteraction succeeded. errorcode (0)
        else 
            //BlockUserInteraction not succeeded. errorcode (-1)
    }
    return CDialog::WindowProc( message, wParam, lParam );
}

void CDlgMFC_BlockUserInteraction::foo()
{
    LPARAM id = GetUniqueID();
    if ( RI_MESSAGE( RI_MESSAGE_BLOCKUSERINTERACTION, GetSafeHwnd(), id ) == RI_NOERROR )
        //message sending succeeded
    else
        //navigation software not running
}

© PTV AG 2011 Generated on Fri Oct 14 2011 10:17:32 for RI by doxygen 1.7.1