xdr_string Subroutine

Purpose

Translates between C language strings and their external representations.

Library

C Library (libc.a)

Syntax

#include <rpc/xdr.h>

xdr_string ( xdrs, sp, maxsize) XDR *xdrs; char **sp; u_int maxsize;

Description

The xdr_string subroutine is a filter primitive that translates between C language strings and their corresponding external representations. Externally, strings are represented as sequences of ASCII characters, while internally, they are represented with character pointers.

Parameters

Item	Description
xdrs	Points to the eXternal Data Representation (XDR) stream handle.
sp	Specifies the address of the pointer to the string.
maxsize	Specifies the maximum length of the string allowed during encoding or decoding. This value is set in a protocol. For example, if a protocol specifies that a file name cannot be longer than 255 characters, then a string cannot exceed 255 characters.

Return Values

Upon successful completion, this subroutine returns a value of 1. If unsuccessful, it returns a value of 0.