Carbon


NSLGetNameFromNeighborhood

Header: NSL.h Carbon status: Supported

Locates the neighborhood name in a neighborhood.

void NSLGetNameFromNeighborhood (
    NSLNeighborhood neighborhood, 
    char **name, 
    SInt32 *length
);
Parameter descriptions
neighborhood

On input, a value of type NSLNeighborhood from which the name is to be obtained.

name

On input, the address of a pointer. On output, name contains the address of a pointer to the name in the neighborhood parameter.

length

On input, a pointer to a location in memory. On output, length points to the length in bytes of the name in the neighborhood parameter.

DISCUSSION

The NSLGetNameFromNeighborhood function locates the name in a neighborhood so that your application can, for example, display the name. The name that NSLGetNameFromNeighborhood locates is not null-terminated. Use the value pointed to by length to determine the length of the name.

The NSLGetNameFromNeighborhood function does not allocate any memory. <8bat>u


© 2000 Apple Computer, Inc. (Last Updated 7/13/2000)