TransportSetInterfaceName

Selects the interface by name. If successful, it can be assigned to a debug engine instance with the EngAssignTransport function.

Syntax

PULSE_STATUS TransportSetInterfaceName(
 [in] PPS_TRANSPORT pTransport,
 [in] char *lpcInterfaceName
);

Parameters

PPS_TRANSPORT pTransport

An opaque handle to a transport created by the TransportCreate function.

char *lpcInterfaceName

Target interface name. It might be one from the enumerated names retrieved by the TransportGetInterfaceName function if enumeration is supported for a given transport type. It may also be any valid name in your system for a given transport type:

Transport type Example name
pttSerial
1		 "\\.\COM1"
pttNet
6		 "192.168.0.1:50100"
pttPipe
9		 "\\.\pipe\named_pipe_1"
pttLocal
10		 "vmcall"

Return value

If the function succeeds, the return value is PULSE_STATUS_SUCCESS.

If it fails, it returns one of the PULSE_STATUS values. Possible return codes include, but are not limited to, the following:

PULSE_STATUS_INSUFFICIENT_RESOURCES
0xC0000002		 One of the memory allocations failed during initialization.
PULSE_STATUS_INVALID_PARAMETER
0xC0000010		 Might happen if:
  • The pTransport argument is NULL.
  • The lpcInterfaceName argument is NULL.
  • The interface with the given name does not exist in the system.
    		•
    PULSE_STATUS_DEVICE_MISCONFIGURATION
    0xC0000306    		 The serial interface cannot be properly configured.
    PULSE_STATUS_DEVICE_INIT_FAILED
    0xC0000307    		 Failed to initialize the pttXhci transport. On Windows, this happens if any WinUSB function fails.
    PULSE_STATUS_TRANSPORT_INIT_FAILED
    0xC0000300    		 Local debugging vmcall test failed. Check your PulseDbg Host settings.

    Remarks

    This function is useful in cases where interfaces cannot be enumerated, f.e. for the pttPipe transport, when you have to specify a pipe name.

    Use this function to select an interface for the pttNet transport type. The format is "ip[:port]", f.e. "192.168.0.1:50123". If the port number is omitted, it will be set to the default value of 50100.

    The only valid interface name for the pttLocal transport type is "vmcall".

    You can also select the interface by enumerating available ones with the TransportEnumerateInterfaces function and then selecting one of them by index with the TransportSetInterfaceIndex function