gc_util_delete_parm_blk( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	void gc_util_delete_parm_blk(parm_blk )
Inputs:	GC_PARM_BLK* parm_blk	pointer to GC_PARM_BLK to be deleted
Returns:	0 if successful <0 if failure
Includes:	gclib.h gcerr.h
Category:	GC_PARM_BLK utility
Mode:	synchronous
Platform and Technology:	All

Description

The gc_util_delete_parm_blk( ) function deletes the specified GC_PARM_BLK.

Parameter	Description
parm_blk	points to the GC_PARM_BLK to be deleted. For more information about the GC_PARM_BLK data structure, see GC_PARM_BLK.

Termination Events

None

Cautions

None

Errors

If this function returns <0 to indicate failure, use the gc_ErrorInfo( ) function to retrieve the reason for the error. See the "Error Handling" section in the Global Call API Programming Guide. All Global Call error codes are defined in the gcerr.h file.

Example

#include "gclib.h" 
void main( ) 
{
    GC_PARM_BLKP my_blkp = NULL;
    GC_PARM_DATAP my_parmp;
    int type = 1; 
    /* insert parm by reference */
    if ( gc_util_insert_parm_ref( &my_blkp, GC_SET_SERVREQ, PARM_REQTYPE,
         sizeof( int ), &type ) != GC_SUCCESS )
    {
        /* Process error */
    } 
    /* insert parm by value */
    if ( gc_util_insert_parm_val( &my_blkp, GC_SET_SERVREQ, PARM_ACK,
         sizeof( short ), GC_ACK ) != GC_SUCCESS )
    {
        /* Process error */
    } 
    /* Now we should have a GC_PARM_BLK with 2 parameters */ 
    /* Following use of gc_util_next_parm retrieves the first parameter in a
     * GC_PARM_BLK, which in this case is PARM_REQTYPE */
    my_parmp = gc_util_next_parm( my_blkp, NULL ); 
    /* Retrieve the next parameter after getting the first one */
    my_parmp = gc_util_next_parm( my_blkp, my_parmp ); 
    /* This function finds and returns specified parameter, NULL if not found */
    my_parmp = gc_util_find_parm( my_blkp, GC_SET_SERVREQ, PARM_ACK ); 
    /* After GC_PARM_BLK is no longer needed, delete the block */
    gc_util_delete_parm_blk( my_blkp ); 
    /* Set my_blkp to NULL now that the block has been deleted */
    my_blkp = NULL;
} 

See Also

• gc_util_insert_parm_ref( )
• gc_util_insert_parm_val( )

Click here to contact Telecom Support Resources