cwbCO_GetDescription

Purpose

This function gets the text description associated with a specified system object.

Syntax

 
UINT CWB_ENTRY cwbCO_GetDescription(
                              cwbCO_SysHandle    system,
                              LPSTR              description,
                              PULONG             length );

Parameters

cwbCO_SysHandle system - input

Handle returned previously from cwbCO_CreateSystem or cwbCO_CreateSystemLike. It identifies the iSeries™ system.

LPSTR description - output

Pointer to a buffer that will contain the NULL-terminated description. The description will be at most CWBCO_MAX_SYS_DESCRIPTION characters long, not including the terminating NULL.

PULONG length - input/output

Pointer to the length of the description buffer. If the buffer is too small to hold the description, including space for the terminating NULL, the size of the buffer needed will be filled into this parameter.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_INVALID_API_HANDLE

Invalid system handle.

CWB_INVALID_POINTER

One of the pointer parameters passed in is NULL.

CWB_BUFFER_OVERFLOW

The description buffer is not large enough to hold the entire description.