Carbon


URLGetPropertySize

Header: URLAccess.h Carbon status: Supported

Determines the size of a URL property.

OSStatus URLGetPropertySize (
    URLReference urlRef, 
    const char *property, 
    Size *propertySize
);
Parameter descriptions
urlRef

A reference to the URL whose property size you want to determine.

property

A pointer to a C string representing the name of the property value whose size you want to determine. For a description of property name constants, see “Universal URL Property Name Constants” and “HTTP and HTTPS URL Property Name Constants”.

propertySize

On return, a pointer to the size (in bytes) of the specified property value. If the size is not available, URLGetPropertySize passes back -1 in this parameter and returns the result code kURLPropertyNotYetKnownError.

function result

A result code.

DISCUSSION

The URLGetProperty function obtains the size of the property value identified by the property name constant passed in the property parameter. For a description of property name constants and data types of the corresponding property values, see “Universal URL Property Name Constants” and “HTTP and HTTPS URL Property Name Constants”.

You should call the URLGetPropertySize function before calling the function URLGetProperty to determine the size of the buffer containing the property value you wish to obtain or set. Pass the value passed back in the propertySize parameter in the bufferSize parameter of URLGetProperty.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


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