INtime SDK Help
ntxGetLocationByName
INtime SDK v7 > About INtime > INtime Kernel > System management calls > ntxGetLocationByName

Returns a handle to the specified location.

NTXLOCATION ntxGetLocationByName(
    char *LocationName
);

NTXLOCATION ntxGetLocationByNameW(
    const TCHAR *LocationName
);

Parameters

LocationName
Pointer to an ASCII string that contains the target RT node's name.

Return Values

The NTXLOCATION value that corresponds to the specified RT kernel.
Success.
NTX_UNDEFINED_LOCATION
Failure.

Remarks

There is limited UNICODE support for some NTX calls. By defining the macro _UNICODE_NTX_MINI_ the standard calls are mapped to their wide-character equivalents.

Status

E_EXIST 0x0006
No RT node with the specified name exists. The node is either offline or not configured. To configure a node, use the INtime Configuration Panel.

Requirements

Versions Defined in Include Link to
INtime 3.0 intime/nt/include/ntx.h ntx.h ntx.lib
INtime 4.01 (for 64-bit Windows) intime/nt/include/ntx.h ntx.h ntx64.lib
See Also

System & Status