test

Sun Java System Calendar Server 6 2005Q4 Developer's Guide

Method: FreeAttribute

Purpose

Free the memory associated with your local attribute storage.

Syntax

PRint32 FreeAttribute (char* aValue, PRInt32 *aReturnCode)=0;

Parameters

The method has the following two parameters:

aValue 

The location you allocated to contain the retrieved attribute value. 

aReturnCode 

On return, contains a constant that determines whether the server should continue with the default, or with the override processing. 

One of the following constants: 

  • NS_CONTINUE_DEFAULT_PROCESSING

  • NS_OVERRIDE_DEFAULT_PROCESSING

Returns

NS_OK on success, non-zero error code on failure.

Description

When you retrieve the value of an attribute using the GetAttribute method, the value is stored at a location that you have allocated, using the memory management technique of your choice. Use the Method: FreeAttribute method to free that memory when it is no longer needed, using the same memory management technique. (See API: csIMalloc.)