GetParameter function

Gets the error parameter string.

Syntax 
size_t ULSqlcaBase::GetParameter(
  ul_u_long parm_num,
  ul_wchar * buffer,
  size_t size
)
Parameters

  • parm_num   A 1-based parameter number.

  • buffer   The buffer to receive parameter string.

  • size   The size, in ul_wchars, of the buffer.

Returns

  • If the function succeeds, the return value is the buffer size required to hold the entire parameter string.

  • If the function fails, the return value is zero. The function fails if an invalid (out of range) parameter number is given.

Remarks

The output parameter string is always null-terminated, even if the buffer is too small and the parameter is truncated. The parameter number is 1-based.

Copyright © 2009, iAnywhere Solutions, Inc. - SQL Anywhere 11.0.1