Runs a search for the specified sponsor based on the flags provided.

LOCATION FindRtSponsor(
    LPSTR lpszSponsorName,
    LOCATION hLocation,
    DWORD dwFlags 
)

Parameters

lpszSponsorName

A zero-terminated string containing the name of the sponsor you want to search for.

hLocation

The meaning of hLocation is based upon the flags passed into the call.

dwFlags

Specifies the type of search that will be run. Only the following values are allowed:

START_SEARCH

Begins at the start of the RT location list and returns the first RT node where the given sponsor name is registered.

CONTINUE_SEARCH

Begins at the next node in the location list after hLocation. Returns the next RT node where the given sponsor name is registered.

THIS_SEARCH_LOCATION

Only search on this node for the given sponsor name.

SPECIFIC_LOCATION

Only searches for the given sponsor name on the node specified by hLocation.

START_WINDOWS_SEARCH

Begins at the start of the Windows location list and returns the first Windows node where the given sponsor name is registered.

CONTINUE_WINDOWS_SEARCH

Begins at the next Windows node in the location list after hLocation. Returns the next Windows node where the given sponsor name is registered.

WINDOWS_HOST_ONLY

Only search on the Windows location which is acting as host. In INtime for Windows, this is the local Windows. On distributed RTOS nodes, this is only for nodes which have registered as a host using the makeintimehost utility.

SPECIFIC_WINDOWS_HOST

Only searches for the given sponsor name on the Windows node specified by hLocation.

Return Values

A valid LOCATION value

Success.

BAD_LOCATION

Failure. To determine the status, call GetLastRtError.
E_PARAM - The sponsor name was invalid
E_CONTEXT - The sponsor is not registered on any nodes within the search parameters

Requirements

Versions	Defined in	Include	Link to
INtime 4.0	intime/rt/include/rtdsm.h	rt.h	rt.lib