test

KCMS Application Developer's Guide

KcsFreeProfile() 

KcsStatusId
 KcsFreeProfile(
 		KcsProfileId    profile)

Purpose

Use KcsFreeProfile() to release all resources a loaded profile is using. A loaded profile uses memory and additional types of resources.

The KCMS framework does not automatically save profile changes when your application terminates. To save profile changes, your application must call KcsSaveProfile().

Note -

If the application passes a KcsFileProfile type of KcsProfileDesc as an argument, KcsFreeProfile() does not close the KcsFileId contained in the file entry of the KcsProfileDesc union.

Arguments

Table 4-9 KcsFreeProfile() Arguments

Argument 

Description 

profile

The identifier of a loaded profile. 

Returns

Table 4-10 KcsConnectProfiles() Return Strings

KCS_SUCCESS

KCS_PROF_ID_BAD

Example

Example 4-4 KcsFreeProfile() 

KcsProfileId						profile;

 /* Complete all processing. */

 KcsFreeProfile(profile);