Assign the enumerator value matching the specified string of the specified stringLength to the specified result.

Synopsis

Declared in <bdlar_enumref.h>

int
bdlat_enumFromString(
    EnumRef* result,
    char const* string,
    int stringLength);

Description

Return 0 on success, and a non‐zero value with no effect on the object if string and stringLength do not match any enumerator.

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

result

enumeration reference to receive the value

string

string representation of the enumerator

stringLength

length of string in bytes

Created with MrDocs