OCI_oerhms

function

Library: Oracle Call Interface database support (OMOCI legacy)
Include: omoci.xin

Returns: Returns the length of the error message.

Declaration

define external integer function OCI_oerhms
   (  value OCI_Handle_type lda,
      value integer rcode,
      modifiable stream buf,
      value integer bufsiz
   )

Purpose

This function returns the text of an Oracle error message for a given error code.

Input arguments:

lda -- Login data area descriptor.
rcode -- The LDA (login data area) or CDA (cursor data area) return code containing the Oracle error number.
bufsiz -- The maximum allowed size of the returned string.

Output argument:

buf -- The returned error message text.

Example:

  set ErrMsgLen to OCI_oerhms
  		(	ConnectionHandle,
  			OCI_GetErrorCode( ConnectionHandle ), 
  			ErrMsg,
  			1024
  		)