sousa-gecko/docs/nspr/reference/pr_getprotobyname.md

PR_GetProtoByName

Looks up a protocol entry based on the protocol's name.

Syntax

#include <prnetdb.h>

PRStatus PR_GetProtoByName(
  const char* protocolname,
  char* buffer,
  PRInt32 bufsize,
  PRProtoEnt* result);

Parameters

The function has the following parameters:

protocolname

A pointer to the character string of the protocol's name.

buffer

A pointer to a scratch buffer for the runtime to return result. This buffer is allocated by the caller.

bufsize

Number of bytes in the buffer parameter. The buffer must be at least {ref}PR_NETDB_BUF_SIZE bytes.

result

On input, a pointer to a {ref}PRProtoEnt structure. On output, this structure is filled in by the runtime if the function returns PR_SUCCESS.

Returns

The function returns one of the following values:

• If successful, PR_SUCCESS.
• If unsuccessful, PR_FAILURE. You can retrieve the reason for the failure by calling {ref}PR_GetError.