cwbUN_GetDisplayNameFromItemId

Purpose

Extracts the item name field from a Unity item identifier.

Syntax

CWBAPI unsigned int WINAPI cwbUN_GetDisplayNameFromItemId(
    const char * szItemId,
    char * szItemName,
    UINT cchMax
    );

Parameters

const char * szItemId - input

The Unity item identifier from which the item name will be extracted.

char * szItemName - output

Address of the buffer that will receive the null-terminated item name.

UINT cchMax - input

Size of the buffer that will receive the null-terminated item name.

Return Codes

The following list shows common return values:

CWB_OK

Successful completion.

CWBUN_FORMAT_NOT_VALID

Specified item identifier not valid.

CWB_BUFFER_OVERFLOW

The buffer is too small to contain the returned string.

Usage

None