CWBSO_RefreshObj

Purpose

Refreshes an object's attributes from the iSeries™ server. Refreshes all open System Object Access views of the object.

Syntax

 
unsigned int CWB_ENTRY CWBSO_RefreshObj(
                CWBSO_OBJ_HANDLE objectHandle,          
                HWND hWnd ,                             
                CWBSO_ERR_HANDLE errorHandle);          

Parameters

CWBSO_OBJ_HANDLE objectHandle - input

A handle to an object that was returned by a previous call to CWBSO_GetObjHandle or CWBSO_CopyObjHandle.

HWND hWnd - input

Handle of window to receive the focus after the refresh is complete. This parameter may be NULL. If this API is being called from an application window procedure, then the current window handle should be supplied. Otherwise, focus will shift to the most recently opened System Object Access window if one is open.

CWBSO_ERR_HANDLE errorHandle - input

A handle to an error object. If an error occurs that there is error text for, this handle may be used to retrieve the error message and message help.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR

No error occurred.

CWBSO_BAD_OBJ_HANDLE

The object handle that is specified is not valid.

CWBSO_BAD_ERR_HANDLE

The error handle that is specified is not valid.

CWBSO_LOW_MEMORY

Not enough memory is available for the request.

CWBSO_ERROR_OCCURRED

An error occurred. Use error handle for more information.

Usage

CWBSO_GetObjHandle or CWBSO_CopyObjHandle must be called prior to calling this API. The object handle that is returned by CWBSO_GetObjHandle or CWBSO_CopyObjHandle must be passed as input to this API. CWBSO_CreateErrorHandle must be called prior to calling this API. The error handle that is returned by CWBSO_CreateErrorHandle must be passed as input to this API.