ictxFreeParseInfo()--Free Authentication Context Parse Info Storage

 #include <ictx.h>;

 int ictxFreeParseInfo
 (
  ictxParseInfo_t     ** parsedContext,
  ictxError_t          * errorInfo
 )

The ictxFreeParseInfo() function frees authentication context parse information storage that was returned from the ictxParseIdTkn API.

Parameters

parsedContext  (Input/Output)

The authentication context parse information 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

• ictxBuildAuthContext() --Build Authentication Context
  
  
• ictxDelegateAuthContext() --Delegate Authentication Context
  
  
• ictxParseAuthContext() --Parse Authentication Context
  
  
• ictxFreeIdContext() --Free Identity Context Storage
  
  

Example

The following example frees parsed information. Note: Read the Code example disclaimer for important legal information.

#include <ictx.h>
#include <string.h>
	
int freeParseInfo  
(
 ictxParseInfo_t ** parsedContext
 )
{
    int rc;
    
    ictxError_t errorInfo;

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