| Mac OS X header: | Carbon/Carbon.h |
| Mac OS 9 header: | URLAccess.h |
| Working With URL Access Manager Callbacks Functions | |
| NewURLNotifyUPP | Creates a UPP to your data transfer event notification callback. |
| NewURLSystemEventUPP | Creates a UPP to your system event notification callback. |
| InvokeURLNotifyUPP | Invokes your data transfer event notification callback. |
| InvokeURLSystemEventUPP | Invokes your system event notification callback. |
| DisposeURLNotifyUPP | Disposes of a UPP to your data transfer event notification callback. |
| DisposeURLSystemEventUPP | Disposes of a UPP to your system event notification callback. |
NewURLNotifyUPP |
| Carbon status: | Supported |
Creates a UPP to your data transfer event notification callback.
URLNotifyUPP NewURLNotifyUPP (
URLNotifyProcPtr userRoutine
);
A pointer to your data transfer event notification callback. For information on how to write your callback, see URLNotifyProcPtr.
A UPP to your data transfer event notification callback. You can register your callback by passing this UPP in the notifyProc parameter of the function
The NewURLNotifyUPP function creates a pointer to your data transfer event notification callback. You pass a pointer to your callback in the notifyProc parameter of the function URLOpen if you want your application to receive data transfer events. Pass a bitmask in the eventRegister parameter of URLOpen indicating which data transfer events you want to receive.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
When you are finished with your data transfer event notification callback, you should dispose of the UPP by calling the function DisposeURLNotifyUPP.
NewURLSystemEventUPP |
| Carbon status: | Supported |
Creates a UPP to your system event notification callback.
URLSystemEventUPP NewURLSystemEventUPP (
URLSystemEventProcPtr userRoutine
);
A pointer to your system event notification callback. For information on how to write your callback, see URLSystemEventProcPtr.
A UPP to your system event notification callback. You can register your callback by passing this UPP in the eventProc parameter of the function
The NewURLSystemEventUPP function creates a pointer to your system event callback function. You pass a pointer to your callback function in the eventProc parameter of the functions URLSimpleDownload, URLSimpleUpload, URLDownload, and URLUpload if you want update events to be passed to your application while a dialog box is displayed. (In Mac OS X, this is not necessary, since all dialog boxes are moveable). In order for these functions to display a dialog box, you must set the mask constant kURLDisplayProgressFlag or kURLDisplayAuthFlag in the bitmask passed in the openFlags parameter.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
When you are finished with your system event notification callback, you should dispose of the UPP by calling the function DisposeURLNotifyUPP.
InvokeURLNotifyUPP |
| Carbon status: | Supported |
Invokes your data transfer event notification callback.
OSStatus InvokeURLNotifyUPP (
void *userContext,
URLEvent event,
URLCallbackInfo *callbackInfo,
URLNotifyUPP userUPP
);
A pointer to application-defined storage. The URL Access Manager passes this value in the userContext parameter of your notification callback function. Your application can use this to set up its context when your data transfer event notification callback is called.
The data transfer events you want your application to receive. See “Data Transfer Event Constants” for a description of possible values. The URL Access Manager tests the bitmask you pass in the eventRegister parameter of the function URLOpen to determine which events to pass to your callback function. See “Data Transfer Event Mask Constants” for a description of this bitmask.
A pointer to a structure of type URLCallbackInfo that provides information about the data transfer event to your callback function. The URL Access Manager passes a pointer to this structure in the callbackInfo parameter of your notification callback function.
A Universal Procedure Pointer to your data transfer notification callback. For information on how to write this function, see URLNotifyProcPtr.
A result code.
The URL Access Manager calls the InvokeURLNotifyUPP function when you pass a UPP to your callback function in the notifyProc parameter of the function URLOpen, and the data transfer event that you specified in the eventRegister parameter occurs.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
InvokeURLSystemEventUPP |
| Carbon status: | Supported |
Invokes your system event notification callback.
OSStatus InvokeURLSystemEventUPP (
void *userContext,
EventRecord *event,
URLSystemEventUPP userUPP
);
A pointer to application-defined storage. The URL Access Manager passes this value in the userContext parameter of your system event callback function. Your application can use this to set up its context when your system event notification callback is called.
A pointer to an event record that provides information about the system event to your callback function.
A Universal Procedure Pointer to your system event notification callback. For information on how to write this function, see URLSystemEventProcPtr.
A result code.
The URL Access Manager calls the InvokeURLSystemEventUPP function when you pass a UPP to your callback function in the eventProc parameter of the functions URLSimpleDownload, URLSimpleUpload, URLDownload, or URLUpload, and a system event occurs while a progress indicator or authentication dialog box is being displayed.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
DisposeURLNotifyUPP |
| Carbon status: | Supported |
Disposes of a UPP to your data transfer event notification callback.
void DisposeURLNotifyUPP (
URLNotifyUPP userUPP
);
A Universal Procedure Pointer (UPP) to your notification callback function.
When you are finished with a UPP to your notification callback function, you should dispose of it by calling the DisposeURLNotifyUPP function.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
DisposeURLSystemEventUPP |
| Carbon status: | Supported |
Disposes of a UPP to your system event notification callback.
void DisposeURLSystemEventUPP (
URLSystemEventUPP userUPP
);
A UPP to your system event callback function.
When you are finished with a UPP to your system event callback function, you should dispose of it by calling the DisposeURLSystemEventUPP function.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
© 2001 Apple Computer, Inc. (Last Updated July 21, 2001)