This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

FreeAR

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Recursively free all allocated memory associated with a particular BMC Remedy AR System data structure. All structure components must be in allocated memory to use these functions.

Privileges

All users.

Synopsis

#include "ar.h"
#include "arfree.h"

void FreeARAccessNameList(
   ARAccessNameList *value,
   ARBoolean freeStruct)

void FreeARAccessNamePtrList(
   ARAccessNamePtrList *value,
   ARBoolean freeStruct)

void FreeARActiveLinkActionList(
   ARActiveLinkActionListList *value,
   ARBoolean freeStruct)

void FreeARActiveLinkActionListList(
   ARActiveLinkActionList *value,
   ARBoolean freeStruct)

void FreeARActiveLinkActionStruct(
   ARActiveLinkActionStruct *value,
   ARBoolean freeStruct)

void FreeARActiveLinkSvcActionStruct(
   ARActiveLinkSvcActionStruct *value,
   ARBoolean freeStruct)

void FreeARArchiveInfoList(
   ARArchiveInfoList *value,
   ARBoolean freeStruct)

void FreeARArchiveInfoStruct(
   ARArchiveInfoStruct *value,
   ARBoolean freeStruct)

void FreeARArithOpAssignStruct(
   ARArithOpAssignStruct *value,
   ARBoolean freeStruct)

void FreeARArithOpStruct(
   ARArithOpStruct *value,
   ARBoolean freeStruct)

void FreeARAssignFieldStruct(
   ARAssignFieldStruct *value,
   ARBoolean freeStruct)

void FreeARAssignSQLStruct(
   ARAssignSQLStruct *value,
   ARBoolean freeStruct)

void FreeARAssignStruct(
   ARAssignStruct *value,
   ARBoolean freeStruct)

void FreeARAttachStruct(
   ARAttachStruct *value,
   ARBoolean freeStruct)

void FreeARAuditInfoList(
   ARAuditInfoList *value,
   ARBoolean freeStruct)

void FreeARAuditInfoStruct(
   ARAuditInfoStruct *value,
   ARBoolean freeStruct)

void FreeARAutomationStruct(
   ARAutomationStruct *value,
   ARBoolean freeStruct)

void FreeARBooleanList(
   ARBooleanList *value,
   ARBoolean freeStruct)

void FreeARBooleanListList(
   ARBooleanListList *value,
   ARBoolean freeStruct)

void FreeARBooleanMatrix(
   ARBooleanMatrix *value,
   ARBoolean freeStruct)

void FreeARBufStruct(
   ARBufStruct *value,
   ARBoolean freeStruct)

void FreeARBulkEntryReturn(
   ARBulkEntryReturn *value,
   ARBoolean freeStruct)

void FreeARBulkEntryReturnList(
   ARBulkEntryReturnList *value,
   ARBoolean freeStruct)

void FreeARByteList(
   ARByteList *value,
   ARBoolean freeStruct)

void FreeARCallGuideStruct(
   ARCallGuideStruct *value,
   ARBoolean freeStruct)

void FreeARCharMenuItemStruct(
   ARCharMenuItemStruct *value,
   ARBoolean freeStruct)

void FreeARCharMenuList(
   ARCharMenuList *value,
   ARBoolean freeStruct)

void FreeARCharMenuSSStruct(
   ARCharMenuSSStruct *value,
   ARBoolean freeStruct)

void FreeARCharMenuStruct(
   ARCharMenuStruct *value,
   ARBoolean freeStruct)

void FreeARCharMenuStructList(
   ARCharMenuStructList *value,
   ARBoolean freeStruct)

void FreeARCOMMethodList(
   ARCOMMethodList *value,
   ARBoolean freeStruct)

void FreeARCOMMethodParmList(
   ARCOMMethodParmList *value,
   ARBoolean freeStruct)

void FreeARCOMMethodParmStruct(
   ARCOMMethodParmStruct *value,
   ARBoolean freeStruct)

void FreeARCOMMethodStruct(
   ARCOMMethodStruct *value,
   ARBoolean freeStruct)

void FreeARComplexEntryService(
   ARComplexEntryService *value,
   ARBoolean freeStruct)

void FreeARComplexEntryServiceList(
   ARComplexEntryServiceList *value,
   ARBoolean freeStruct)

void FreeARComplexEntryServiceOut(
   ARComplexEntryServiceOut *value,
   ARBoolean freeStruct)

void FreeARComplexEntryServiceOutList(
   ARComplexEntryServiceOutList *value,
   ARBoolean freeStruct)

void FreeARCompoundSchema(
   ARCompoundSchema *value,
   ARBoolean freeStruct)

void FreeARCompoundSchemaList(
   ARCompoundSchemaList *value,
   ARBoolean freeStruct)

void FreeARCOMValueStruct(
   ARCOMValueStruct *value,
   ARBoolean freeStruct)

void FreeARContainerInfoList(
   ARContainerInfoList *value,
   ARBoolean freeStruct)

void FreeARContainerOwnerObjList(
   ARContainerOwnerObjList *value,
   ARBoolean freeStruct)

void FreeARContainerOwnerObjListList(
   ARContainerOwnerObjListList *value,
   ARBoolean freeStruct)

void FreeARContainerTypeList(
   ARContainerTypeList *value,
   ARBoolean freeStruct)

void FreeARCoordList(
   ARCoordList *value,
   ARBoolean freeStruct)

void FreeARCurrencyList(
   ARCurrencyList *value,
   ARBoolean freeStruct)

void FreeARCurrencyStruct(
   ARCurrencyStruct *value,
   ARBoolean freeStruct)

void FreeARDataMappingInfoList(
   ARDataMappingInfoList *value,
   ARBoolean freeStruct)

void FreeARDataMappingInfoStruct(
   ARDataMappingInfoStruct *value,
   ARBoolean freeStruct)

void FreeARDDEStruct(
   ARDDEStruct *value,
   ARBoolean freeStruct)

void FreeARDiaryList(
   ARDiaryList *value,
   ARBoolean freeStruct)

void FreeARDisplayInstanceList(
   ARDisplayInstanceList *value,
   ARBoolean freeStruct)

void FreeARDisplayInstanceListList(
   ARDisplayInstanceListList *value,
   ARBoolean freeStruct)

void FreeARDisplayInstanceListPtrList(
   ARDisplayInstanceListPtrList *value,
   ARBoolean freeStruct)

void FreeARDisplayInstanceStruct(
   ARDisplayInstanceStruct *value,
   ARBoolean freeStruct)

void FreeARDisplayList(
   ARDisplayList *value,
   ARBoolean freeStruct)

void FreeAREntryBlockList(
   AREntryBlockList *value,
   ARBoolean freeStruct)

void FreeAREntryBlockStruct(
   AREntryBlockStruct *value,
   ARBoolean freeStruct)

void FreeAREntryIdList(
   AREntryIdList *value,
   ARBoolean freeStruct)

void FreeAREntryIdListList(
   AREntryIdListList *value,
   ARBoolean freeStruct)

void FreeAREntryInfoList(
   AREntryInfoListList *value,
   ARBoolean freeStruct)

void FreeAREntryListFieldList(
   AREntryListFieldList *value,
   ARBoolean freeStruct)

void FreeAREntryListFieldListList(
   AREntryListFieldListList *value,
   ARBoolean freeStruct)

void FreeAREntryListFieldValueList(
   AREntryListFieldValueList *value,
   ARBoolean freeStruct)

void FreeAREntryListFieldValueStruct(
   AREntryListFieldValueStruct *value,
   ARBoolean freeStruct)

void FreeAREntryListList(
   AREntryListList *value,
   ARBoolean freeStruct)

void FreeAREnumItemList(
   AREnumItemList *value,
   ARBoolean freeStruct)

void FreeARFieldAssignList(
   ARFieldAssignList *value,
   ARBoolean freeStruct)

void FreeARFieldAssignStruct(
   ARFieldAssignStruct *value,
   ARBoolean freeStruct)

void FreeARFieldInfoList(
   AREntryFieldInfoList *value,
   ARBoolean freeStruct)

void FreeARFieldInfoStruct(
   AREntryFieldInfoStruct *value,
   ARBoolean freeStruct)

void FreeARFieldLimitList(
   ARFieldLimitList *value,
   ARBoolean freeStruct)

void FreeARFieldLimitPtrList(
   ARFieldLimitPtrList *value,
   ARBoolean freeStruct)

void FreeARFieldLimitStruct(
   ARFieldLimitStruct *value,
   ARBoolean freeStruct)

void FreeARFieldMappingList(
   ARFieldFieldMappingList *value,
   ARBoolean freeStruct)

void FreeARFieldMappingPtrList(
   ARFieldMappingPtrList *value,
   ARBoolean freeStruct)

void FreeARFieldValueList(
   ARFieldValueList *value,
   ARBoolean freeStruct)

void FreeARFieldValueListList(
   ARFieldValueListList *value,
   ARBoolean freeStruct)

void FreeARFieldValueOrArithStruct(
   ARFieldValueOrArithStruct *value,
   ARBoolean freeStruct)

void FreeARFieldValueStruct(
   ARFieldValueStruct *value,
   ARBoolean freeStruct)

void FreeARFilterActionList(
   ARFilterActionList *value,
   ARBoolean freeStruct)

void FreeARFilterActionListList(
   ARFilterActionListList *value,
   ARBoolean freeStruct)

void FreeARFilterActionNotifyAdvanced(
   ARFilterActionNotifyAdvanced *value,
   ARBoolean freeStruct)

void FreeARFilterActionStruct(
   ARFilterActionStruct *value,
   ARBoolean freeStruct)

void FreeARFullTextInfoList(
   ARFullTextInfoList *value,
   ARBoolean freeStruct)

void FreeARFullTextInfoRequestList(
   ARFullTextInfoRequestList *value,
   ARBoolean freeStruct)

void FreeARFunctionAssignStruct(
   ARFunctionAssignStruct *value,
   ARBoolean freeStruct)

void FreeARGotoGuideLabelStruct(
   ARGotoGuideLabelStruct( *value,
   ARBoolean freeStruct)

void FreeARGroupInfoList(
   ARGroupInfoList *value,
   ARBoolean freeStruct)

void FreeARHostIDTypeList(
   ARHostIDTypeList *value,
   ARBoolean freeStruct)

void FreeARIndexList(
   ARIndexList *value,
   ARBoolean freeStruct)

void FreeARIndexListList(
   ARIndexListList *value,
   ARBoolean freeStruct)

void FreeARInternalIdList(
   ARInternalIdList *value,
   ARBoolean freeStruct)

void FreeARInternalIdListList(
   ARInternalIdListList *value,
   ARBoolean freeStruct)

void FreeARLicenseInfoList(
   ARLicenseInfoList *value,
   ARBoolean freeStruct)

void FreeARLicenseInfoStruct(
   ARLicenseInfoStruct *value,
   ARBoolean freeStruct)

void FreeARLicenseNameStruct(
   ARLicenseNameStruct *value,
   ARBoolean freeStruct)

void FreeARLicenseValidList(
   ARLicenseValidList *value,
   ARBoolean freeStruct)

void FreeARLicenseValidStruct(
   ARLicenseValidStruct *value,
   ARBoolean freeStruct)

void FreeARLocaleList(
   ARLocaleList *value,
   ARBoolean freeStruct)

void FreeARLocStruct(
   ARLocStruct *value,
   ARBoolean freeStruct)

void FreeARMacroParmList(
   FreeARMacroParmList *value,
   ARBoolean freeStruct)

void FreeARNameList(
   ARNameList *value,
   ARBoolean freeStruct)

void FreeARNamePtrList(
   ARNamePtrList *value,
   ARBoolean freeStruct)

void FreeARObjectInfoList(
   ARObjectInfoList *value,
   ARBoolean freeStruct)

void FreeARObjectInfoStruct(
   ARObjectInfoStruct *value,
   ARBoolean freeStruct)

void FreeAROpenDlgStruct(
   AROpenDlgStruct *value,
   ARBoolean freeStruct)

void FreeARPasswordList(
   ARPasswordList *value,
   ARBoolean freeStruct)

void FreeARPermissionList(
   ARPermissionList *value,
   ARBoolean freeStruct)

void FreeARPermissionListList(
   ARPermissionListList *value,
   ARBoolean freeStruct)

void FreeARPermissionListPtrList(
   ARPermissionListPtrList *value,
   ARBoolean freeStruct)

void FreeARPropList(
   ARPropList *value,
   ARBoolean freeStruct)

void FreeARPropListList(
   ARPropListList *value,
   ARBoolean freeStruct)

void FreeARPropStruct(
   ARPropStruct *value,
   ARBoolean freeStruct)

void FreeARPushFieldsList(
   ARPushFieldsList *value,
   ARBoolean freeStruct)

void FreeARQualifierList(
   ARQualifierList *value,
   ARBoolean freeStruct)

void FreeARQualifierStruct(
   ARQualifierStruct *value,
   ARBoolean freeStruct)

void FreeARReferenceList(
   ARReferenceList *value,
   ARBoolean freeStruct)

void FreeARReferenceListList(
   ARReferenceListList *value,
   ARBoolean freeStruct)

void FreeARReferenceStruct(
   ARReferenceStruct *value,
   ARBoolean freeStruct)

void FreeARReferenceTypeList(
   ARReferenceTypeList *value,
   ARBoolean freeStruct)

void FreeARRelOpStruct(
   ARRelOpStruct *value,
   ARBoolean freeStruct)

void FreeARRoleInfoList(
   ARRoleInfoList *value,
   ARBoolean freeStruct)

void FreeARSchemaInheritanceList(
   ARSchemaInheritanceList *value,
   ARBoolean freeStruct)

void FreeARSchemaInheritanceListList(
   ARSchemaInheritanceListList *value,
   ARBoolean freeStruct)

void FreeARSchemaInheritanceStruct(
   ARSchemaInheritanceStruct  *value,
   ARBoolean freeStruct)

void FreeARServerInfoList(
   ARServerInfoList *value,
   ARBoolean freeStruct)

void FreeARServerInfoRequestList(
   ARServerInfoRequestList *value,
   ARBoolean freeStruct)

void FreeARServerNameList(
   ARServerNameList *value,
   ARBoolean freeStruct)

void FreeARSignalList(
   ARSignalList *value,
   ARBoolean freeStruct)

void FreeARSortList(
   ARSortList *value,
   ARBoolean freeStruct)

void FreeARSortListList(
   ARSortListList *value,
   ARBoolean freeStruct)

void FreeARSQLStruct(
   ARSQLStruct *value,
   ARBoolean freeStruct)

void FreeARStatisticsResultList(
   ARStatisticsResultList *value,
   ARBoolean freeStruct)

void FreeARStatusHistoryList(
   ARStatusHistoryList *value,
   ARBoolean freeStruct)

void FreeARStatusList(
   ARStatusList *value,
   ARBoolean freeStruct)

void FreeARStatusListList(
   ARStatusListList *value,
   ARBoolean freeStruct)

void FreeARStructItemList(
   ARStructItemList *value,
   ARBoolean freeStruct)

void FreeARSupportFileInfoList(
   ARSupportFileInfoList *value,
   ARBoolean freeStruct)

void FreeARSupportFileInfoStruct(
   ARSupportFileInfoStruct *value,
   ARBoolean freeStruct)

void FreeARTextStringList(
   ARTextStringList *value,
   ARBoolean freeStruct)

void FreeARTimestampList(
   ARTimestampList *value,
   ARBoolean freeStruct)

void FreeARUnsignedIntList(
   ARUnsignedIntList *value,
   ARBoolean freeStruct)

void FreeARUnsignedIntPtrList(
   ARUnsignedIntPtrList *value,
   ARBoolean freeStruct)

void FreeARUserInfoList(
   ARUserInfoList *value,
   ARBoolean freeStruct)

void FreeARUserLicenseList(
   ARUserLicenseList *value,
   ARBoolean freeStruct)

void FreeARUserLicenseStruct(
   ARUserLicenseStruct *value,
   ARBoolean freeStruct)

void FreeARValueList(
   ARValueList *value,
   ARBoolean freeStruct)

void FreeARValueListList(
   ARValueListList *value,
   ARBoolean freeStruct)

void FreeARValuePtrList(
   ARValuePtrList *value,
   ARBoolean freeStruct)

void FreeARValueStruct(
   ARValueStruct *value,
   ARBoolean freeStruct)

void FreeARVuiInfoList(
   ARVuiInfoList *value,
   ARBoolean freeStruct)

void FreeARVuiInfoStruct(
   ARVuiInfoStruct *value,
   ARBoolean freeStruct)

void FreeARWaitStruct(
   ARWaitStruct *value,
   ARBoolean freeStruct)

void FreeARWorkflowConnectList(
   ARWorkflowConnectList *value,
   ARBoolean freeStruct)

void FreeARWorkflowConnectStruct(
   ARWorkflowConnectStruct *value,
   ARBoolean freeStruct)

void FreeARXMLInputDoc(
   ARXMLInputDoc *value,
   ARBoolean freeStruct)

void FreeARXMLOutputDoc(
   ARXMLOutputDoc *value,
   ARBoolean freeStruct)

void FreeARXMLParsedStream(
   ARXMLParsedStream *value,
   ARBoolean freeStruct)

void FreeARXMLParserHandle(
   ARXMLParserHandle *value,
   ARBoolean freeStruct)

void FreeListARCharMenuStruct(
   ListARCharMenuStruct *value,
   ARBoolean freeStruct)

Input arguments

value

A pointer to the structure that you want to free. The system does not perform an operation if the structure is a list with zero items or you specify NULL for this parameter.

freeStruct

A flag that indicates whether you need to free the top-level structure. If you allocated memory for the top-level structure, specify 1 (TRUE) to free both the structure and its contents. If you used a stack variable for the top-level structure, specify 0 (FALSE) to free only the contents of the structure.

Was this page helpful? Yes No Submitting... Thank you

Comments