cwbUN_GetDisplayPathFromName

Purpose

Converts a fully-qualified Unity object name to a fully-qualified pathname suitable for displaying to the user.

Syntax

CWBAPI unsigned int WINAPI cwbUN_GetDisplayPathFromName(
    const char * szObjectName,
    char * szPathName,
    UINT cchMax
    );

Parameters

const char * szObjectName - input

The Unity object name from which the pathname will be derived.

char * szPathName - output

Address of the buffer that will receive the null-terminated pathname.

UINT cchMax - input

Size of the buffer that will receive the null-terminated pathname.

Return Codes

The following list shows common return values:

CWB_OK

Successful completion.

CWBUN_FORMAT_NOT_VALID

Specified object name is not valid.

CWB_BUFFER_OVERFLOW

The buffer is too small to contain the returned string.

Usage

None