Open topic with navigation

SK_ApiContextSetFieldString Function

Sets an string field in the API Context.

Syntax

C/C++: SK_ResultCode SK_ApiContextSetFieldString(SK_ApiContext context, int flags, SK_ApiContext_StringFields field, const char *value);
Visual Basic: Declare Function SK_ApiContextSetFieldString(ByVal context As Long, ByVal flags As Long, ByVal field As Long, ByVal value As String) As Long

Arguments

context: The API Context handle.

flags: Any flags passed into this function-call.

field: The unique Field ID for the field being set (see SK_ApiContext_StringFields for possible values).

value: The new value to store in the field.

Returns

All possible return values are included in the SK_ResultCode enumeration. Return codes to expect include:

Result Code	Description
SK_ResultCode.SK_ERROR_NONE	No error.
SK_ResultCode.SK_ERROR_INVALID_DATA	The presence of invalid data has been detected.
SK_ResultCode.SK_ERROR_INVALID_ARGUMENTS	Some or all of the arguments are invalid.
SK_ResultCode.SK_ERROR_MEMORY_ALLOCATION	Memory could not be allocated.