Carbon


NSLCopyNeighborhood

Header: NSL.h Carbon status: Supported

Copies a neighborhood.

NSLNeighborhood NSLCopyNeighborhood (
    NSLNeighborhood neighborhood
);
Parameter descriptions
neighborhood

On input, a value of type NSLNeighborhood representing the neighborhood that is to be copied.

function result

An NSLNeighborhood value that can be used in a subsequent call to NSLStartServicesLookup. If NSLCopyNeighborhood can’t create the copy of neighborhood, it returns NULL. This might happen, for example, if there is not enough memory.

DISCUSSION

The NSLCopyNeighborhood function creates a copy of the specified neighborhood. When an application calls the NSL Manager’s NSLStartNeighborhoodLookup function, it passes a neighborhood as a parameter. The NSL Manager passes the neighborhood to one or more plug-ins. The calling application can delete the neighborhood at any time, so upon receipt of a neighborhood, each plug-in should call NSLCopyNeighborhood to make a copy of it.

When you have no further use for an NSLNeighborhood value, you can reclaim the memory allocated to it by calling NSLFreeNeighborhood NSLFreeNeighborhood.


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