RELEASE example

The following shows an example of a COBOL call routine to execute a RELEASE request.
*
* The request field must be populated for each call to perform 
* a RETRIEVE.                                                  
*                                                              
     Set  CS-RequestRelease             to True                
     Move Spaces                        to CS-Message          

     Call Structured-API-Program                               
         using                                                 
             CS-CommonStructure                                

     If CS-Message > spaces                                    
       Move CS-Message to Report-error-message                 
       Write Report-out                                        
     End-if                                                    
                                                               
     If     CS-ReturnCode =     0                              
        Perform Release-Successful                             
     Else                                                      
        Perform Release-Errors                                 
     End-If.

RELEASEA, RELEASEC, RELEASED, RELEASEH and RELEASEL APIs

A RELEASEA, RELEASEC, RELEASED, RELEASEH or RELEASEL request passed to the API requests that a specific storage area obtained for a returned structure in the execution of a prior request be freed. Other than the request value placed in CS-Request, these requests use the same CommonStructure fields as the RELEASE request. Below are the differences for each request.
  1. For a RELEASEA the Annotations List Structure will be freed. The following COBOL statement sets the request: Set CS-RequestReleaseA to True
  2. For a RELEASEC the FolderCriteriaStructure will be freed. The following COBOL statement sets the request: Set CS-RequestReleaseC to True
  3. For a RELEASED the Document Structure will be freed. The following COBOL statement sets the request: Set CS-RequestReleaseD to True
  4. For a RELEASEH the HitListStructure will be freed. The following COBOL statement sets the request: Set CS-RequestReleaseH to True
  5. For a RELEASEL the FolderListStructure will be freed. The following COBOL statement sets the request: Set CS-RequestReleaseL to True