ictxFreeIdContextCredential()--Free Identity Context Credential

 #include <ictx.h>;

 int ictxFreeIdContextCredential
 (
 ictxIdContextCredential_t  ** credential,
  ictxError_t          * errorInfo
 )

The ictxFreeIdContextCredential() function frees storage that was returned from other identity context APIs.

Parameters

credential  (Input/Output)

The credential storage that is to be freed. This parameter will be set to NULL.

errorInfo  (Output)

The structure in which to return error code information. If the return value is not 0, errorInfo is set with additional information. This parameter may be NULL. For the format of the structure, see ictxError--Identity Context Return Code Parameter.

Return Value

The return value from the API.

0

Request was successful.

ICTXERR_PARM_REQ (1)

Missing required parameter. Please check API documentation.

eServer Implementation Notes

1. AIX implementation details:
   • Authority: None
2. Linux implementation details:
   • Authority: None
3. i5/OS implementation details:
   
   • Service Program Name: QSYS/QSYICTX
     
   • Authority: Default public authority *USE
4. Windows implementation details:
   • Authority: Users must have administrative privilege to install and work with the APIs.
5. z/OS implementation details:
   
   • Authority: The caller of the API must be APF-authorized.

Related Information

• ictxStoreIdContext() --Store Identity Context
  
  
• ictxRetrieveIdContext() --Retrieve Identity Context
  
  
• ictxRemoveIdContext() --Remove Identity Context
  
  
• ictxFreeIdContext() --Free Identity Context Storage
  
  

Example

The following example frees an identity context credential. Note: Read the Code example disclaimer for important legal information.

#include <ictx.h>
#include <string.h>
	
int freeIdContextCred
(
 ictxIdContextCredential_t  ** credential
 )
{
    int rc;
    
    ictxError_t errorInfo;

    if (0 != (rc = itxFreeIdContext(credential,
                                   &errorInfo)))
    {
	.
	.
	.
        return -1;
    }
    return 0;
}