OpenersNotesSection(Spacer1)Details

WSTP currently supports the following link protocol names: SharedMemory, TCPIP, IntraProcess, Pipes, FileMap, and TCP.

Not all link protocols are available on all platforms.

WSGetAvailableLinkProtocolNames() allocates memory to store the list of protocol names that must be released by calling (NonWLLink[WSReleaseLinkProtocolNames(), paclet:ref/c/WSReleaseLinkProtocolNames]). If WSGetAvailableLinkProtocolNames() returns an error, do not call (NonWLLink[WSReleaseLinkProtocolNames(), paclet:/ref/c/WSReleaseLinkProtocolNames]) on the contents of p.

WSGetAvailableLinkProtocolNames() returns 0 on success and a nonzero error code on failure.

WSGetAvailableLinkProtocolNames() is declared in the WSTP header file (RefLink[wstp.h, paclet:ref/file/wstp.h]).

OpenersPrimaryExamplesSection(Spacer1)Examples  (1)

OpenersExampleSection0(Spacer1)Basic Examples  (1)

#include "wstp.h"

int main()
{
	WSENV env;
	char **protocolNames;
	int length;
	int apiResult;

	env = WSInitialize((WSEnvironmentParameter)0);
	if(env == (WSENV)0)
	{ /* Unable to create WSTP environment */ }

	apiResult = WSGetAvailableLinkProtocolNames(env, &protocolNames, &length);
	if(apiResult != 0)
	{ /* Unable to retrieve link protocol names */ }

	/* ... */

	WSReleaseLinkProtocolNames(env, protocolNames, length);

	WSDeinitialize(env);
}

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[WSOpenArgcArgv(), paclet:ref/c/WSOpenArgcArgv])  ▪  (NonWLLink[WSOpenString(), paclet:ref/c/WSOpenString])  ▪  (NonWLLink[WSReleaseLinkProtocolNames(), paclet:ref/c/WSReleaseLinkProtocolNames]) }})}})

({{DocumentationFooterIconsRelatedTutorial.png, ({{Tutorials}, {▪(RefLinkPlain[WSTP C API Developer Guide (Mac OS X), paclet:tutorial/WSTPDeveloperGuide-MacintoshOverview])}, {▪(RefLinkPlain[WSTP C API Developer Guide (Unix and Linux), paclet:tutorial/WSTPDeveloperGuide-UnixOverview])}, {▪(RefLinkPlain[WSTP C API Developer Guide (Windows), paclet:tutorial/WSTPDeveloperGuide-WindowsOverview])}})}})

({{DocumentationFooterIconsRelatedGuide.png, ({{Related Guides}, {▪(RefLinkPlain[Alphabetical Listing of WSTP C Functions, paclet:guide/AlphabeticalListingOfWSTPCFunctions])}, {▪(RefLinkPlain[WSTP C Language Functions, paclet:guide/WSTPCLanguageFunctions])}})}})