Carbon


NSLHexDecodeText

Header: NSL.h Carbon status: Under Evaluation

Decodes the encoded portion of a URL.

OSStatus NSLHexDecodeText (
    const char *encodedText, 
    UInt16 encodedTextLen, 
    char *decodedTextBuffer, 
    UInt16 *decodedTextBufferLen, 
    Boolean *textChanged
);
Parameter descriptions
encodedText

On input, a pointer to a buffer containing the portion of a URL that has been encoded.

encodedTextLen

On input, a value of type UInt16 that specifies the length of encodedText.

decodedTextBuffer

On input, a pointer to a buffer in which the decoded text is to be stored. On output, decodedTextBuffer contains the decoded text.

decodedTextBufferLen

On input, a pointer to a value of type UInt16 containing the maximum length of decodedTextBuffer. On output, decodedTextBufferLen contains the length of the decoded text pointed to by decodedTextBuffer.

textChanged

On input, a pointer to a Boolean value. On output, textChanged points to a value that is TRUE if the contents of the string pointed to by encodedText does not match the content of the string pointed to by decodedTextBuffer.

function result

A result code. A value of noErr indicates that NSLHexDecodeText returned successfully.

DISCUSSION

The NSLHexDecodeText function decodes the portion of a URL that has been encoded by calling NSLHexEncodeText.

If NSLHexDecodeText returns noErr, and textChanged is FALSE, decodedTextBuffer points to a copy of the data pointed to by encodedText. That is, the data pointed to by encodedText is copied regardless of whether any decoding takes place.


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