Carbon


NSLGetNextNeighborhood

Header: NSL.h Carbon status: Supported

Obtains the next neighborhood in a buffer.

Boolean NSLGetNextNeighborhood (
    NSLClientAsyncInfoPtr infoPtr, 
    NSLNeighborhood *neighborhood, 
    SInt32 *neighborhoodLength
);
Parameter descriptions
infoPtr

On input, a pointer to an NSLClientAsyncInfo structure whose resultBuffer field may contain another neighborhood.

neighborhood

On input, a pointer to a value of type NSLNeighborhood. On output, neighborhood points to the next neighborhood in the resultBuffer field of the NSLClientAsyncInfo structure pointed to by infoPtr.

neighborhoodLength

On output, the length of the neighborhood pointed to by neighborhood.

function result

A Boolean value. A value of TRUE indicates that neighborhood points to the next neighborhood in resultBuffer. A value of FALSE indicates that there are no more neighborhoods in resultBuffer.

DISCUSSION

The NSLGetNextNeighborhood function obtains the starting position and the length of the next neighborhood in a result buffer.

If you want to keep a copy of the neighborhood, call NSLCopyNeighborhood to copy the neighborhood from the buffer.

If you want to get the name of the neighborhood, call NSLGetNameFromNeighborhood.


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