CWBSO_CreateObjHandle

Purpose

Creates a new object handle and returns a handle to the object. Use this API to access remote object that do not conform to the list format.

Syntax

 
unsigned int CWB_ENTRY CWBSO_CreateObjHandle(
                char far* lpszSystemName,               
                char far* lpszApplicationName,          
                CWBSO_OBJTYPE type,                    
                CWBSO_OBJ_HANDLE far* lpObjHandle);   

Parameters

char far* lpszSystemName - input

The name of the iSeries™ system on which the object will be built. The name that is specified must be a configured iSeries server. If the client is not currently connected to the iSeries, a connection will be established when the list is opened. If NULL is specified for the system name, the current iSeries default system will be used.

char far* lpszApplicationName - input

A character string that identifies the application that will be interacting with the list. The maximum length of this string is 10 characters, excluding the NULL terminator.

CWBSO_OBJTYPE type - input

The type of object to be built. Specify the following:

• CWBSO_OBJ_TCIPATTR - TCP/IP attributes

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR

No error occurred.

CWBSO_LOW_MEMORY

Not enough memory is available for the request.

CWBSO_BAD_SYSTEM_NAME

The system name that is specified is not a valid iSeries system name.

Usage

When the list is no longer needed, the calling program is responsible for doing the following:

• Call CWBSO_DeleteObjHandle to free up resources that are allocated on the client.