ClearStopOffPointFromFavoriteList: Delete a stop off point from the favoritelist

Classes
struct	RI_CClearStopOffPointFromFavoriteList
	Data structure for the Request "ClearStopOffPointFromFavoriteList". More...

Functions
LRESULT	RI_ClearStopOffPointFromFavoriteList_ReadData (LPARAM, RI_CClearStopOffPointFromFavoriteList &)
	Read data from shared memory for "Clear Stop Off Point From FavoriteList".
LRESULT	RI_ClearStopOffPointFromFavoriteList_WriteData (LPARAM, RI_CClearStopOffPointFromFavoriteList &)
	Write data to shared memory for "Clear Stop Off Point From FavoriteList".

Variables
const UINT	RI_MESSAGE_DELFROMFAVORITELIST = RegisterWindowMessage(TEXT("RI_MESSAGE_DELFROMFAVORITELIST"))

Detailed Description

Variable Documentation

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

Message ID for the Request "Clear Stop Off Point From FavoriteList":
RI_MESSAGE_DELFROMFAVORITELIST

Write Memory:

RI_ClearStopOffPointFromFavoriteList_WriteData(LPARAM id, RI_CClearStopOffPointFromFavoriteList data );

Read Memory:

RI_ClearStopOffPointFromFavoriteList_ReadData(LPARAM id, RI_CClearStopOffPointFromFavoriteList data );

Return Values for ClearStopOffPointFromFavoriteList:

RI_NOERROR = The stop off point was successfully deleted
RI_NOTFOUND = The stop off point was not found

Description:

Deletes a station from the favorites list.

Returns a single package

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_ClearStopOffPointFromFavoriteList::WindowProc ( UINT  message , WPARAM  wParam , LPARAM  lParam )
{
    //check messages for answer from RI
    if ( message == RI_MESSAGE_DELFROMFAVORITELIST )
    {
        if ( (LRESULT)wParam == RI_NOERROR )
        {
            RI_CClearStopOffPointFromFavoriteList data;
            LRESULT read_suc = RI_ClearStopOffPointFromFavoriteList_ReadData( lParam, data );
            TRACE( TEXT("The stop off point with the unique ID %i"),data.m_StationID );
            TRACE( TEXT("was successfully deleted. errorcode (0)\r\n") );
        }
        else if ( (LRESULT)wParam == RI_NOTFOUND )
            //Stop off Point was not removed, because no Station found. errorcode (5)
    }
    return CDialog::WindowProc( message, wParam, lParam );
}

void CDlgMFC_ClearStopOffPointFromFavoriteList::foo()
{
    //*** copy data ***
    RI_CClearStopOffPointFromFavoriteList data;
    //write UniqueID from Station
    data.m_StationID = 348;

    //*** write data in shared memory ***
    LPARAM id = GetUniqueID();
    LRESULT sharing_ret = RI_ClearStopOffPointFromFavoriteList_WriteData( id, data );
    if ( sharing_ret != RI_NOERROR )
        return;
    if ( RI_MESSAGE( RI_MESSAGE_DELFROMFAVORITELIST, GetSafeHwnd(), id ) == RI_NOERROR )
        //message sending succeeded
    else
        //navigation software not running
}