---

NSLError

A structure returned by many Network Services Location Manager functions containing a result code as well as a context value.

typedef struct NSLError {
OSStatus    theErr;
UInt32  theContext;
};
typedef struct NSLError NSLError;
typedef NSLError * NSLErrorPtr;

Fields

theErr

The result code.

theContext

A value the Network Services Location Manager uses to determine the context of an error so that it can provide an appropriate error message when NSLErrorToString is called.

Discussion

To determine if an error occurred, compare the constant kNSLErrorNoErr to the value returned by a function that returns an NSLError structure.

If you want to display information about the error to the user, your application should call NSLErrorToString and pass the NSLError structure that your application received. The NSLErrorToString function returns two strings — a problem string and a solution string — that your application can display.

Availability

• Available in Mac OS X v10.0 and later.

Declared In

NSLCore.h

---