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

Return type: Integer 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
   )

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
  		)

Other Library Functions OCI_Array_type OCI_GetArrayAsCounter OCI_GetArrayAsCounterShelf OCI_GetArrayAsStream OCI_GetArrayAsStreamShelf OCI_GetArrayAsString OCI_GetArrayElementCount OCI_GetArrayElementLen OCI_GetErrorCode OCI_Handle_type OCI_HostData_type OCI_IsVersionCompatible OCI_LibraryVersion OCI_obindps OCI_obndra OCI_obndrn OCI_obndrv OCI_ocan OCI_oclose OCI_ocof OCI_ocom OCI_ocon OCI_odefin OCI_odefinps OCI_odescr OCI_odessp OCI_oerhms OCI_oexec OCI_oexfet OCI_oexn OCI_ofen OCI_ofetch OCI_oflng OCI_ogetpi OCI_olog OCI_ologof OCI_onbclr OCI_onbset OCI_onbtst OCI_oopen OCI_oopt OCI_oparse OCI_orol OCI_osetpi OCI_SetArrayAsCounter OCI_SetArrayAsCounterShelf OCI_SetArrayAsStream OCI_SetArrayAsStreamShelf OCI_SetArrayAsString OCI_SetArraySize

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]