Carbon


NSLErrorToString

Header: NSL.h Carbon status: Supported

Obtains information about an error.

OSStatus NSLErrorToString (
    NSLError theErr, 
    char *errorString, 
    char *solutionString
);
Parameter descriptions
theErr

On input, an NSLError structure whose theErr field contains an NSL error number.

errorString

On input, a pointer to the buffer in which NSLErrorToString is to place a null-terminated string containing a description of the problem that caused the error. The length of errorString should be 256 bytes.

solutionString

On input, a pointer to the buffer in which NSLErrorToString is to place a null-terminated string containing a possible solution to the problem. The length of solutionString should be 256 bytes.

function result

A result code. A value of noErr indicates that NSLErrorToString returned successfully. If NSLError.theContext is zero and NSLError.theErr contains an error number that is not within the range of NSL error numbers, NSLErrorToString returns kNSLBadReferenceErr.

DISCUSSION

The NSLErrorToString function obtains information about an NSLError structure so that your application can display an appropriate error message. The NSLError structure may have been returned by the NSL Manager or by an NSL plug-in. For any given lookup, search results may be returned by more than one plug-in. You may not want to display an error message if one or more plug-ins return data without error.


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