VastbaseG100

基于openGauss内核开发的企业级关系型数据库。

Menu

Ref类型接口

OCIRefAssign

功能描述

将一个 REF 分配给另一个 REF,以便两者都引用同一对象。

功能说明

将一个 REF 分配给另一个 REF,以便两者都引用同一对象。

接口信息

函数/过程

OCIRefAssign 语法如下:

sword OCIRefAssign ( OCIEnv             *env, 
                     OCIError           *err, 
                     const OCIRef       *source, 
                     OCIRef            **target )

具体参数解释如下:

  • env(IN/OUT):在对象模式下初始化的 OCI 环境句柄。
  • err(IN/OUT):OCI 错误句柄。如果存在错误,则会将其记录在 err 中,此函数返回OCI_ERROR。通过调用 OCIErrorGet()获取诊断信息。
  • source(IN):要拷贝的源Ref。
  • target (IN/OUT):要拷贝的目标Ref的地址。

其他说明

OCIRefClear

功能描述

清理OCIRef类型。

功能说明

如果 REF 不再指向对象,则将其视为空 REF。空引用仍然是有效的 SQL 值,而不是 SQL NULL。它可以用作表中行的 NOT NULL 列或属性的有效非 NULL 常量 REF 值。如果 NULL 指针值作为 REF 传递,则此函数不可操作。

数据相关性

接口信息

函数/过程

OCIRefClear 语法如下:

void OCIRefClear ( OCIEnv        *env,
                   OCIRef        *ref );

参数的解释如下:

  • env(IN/OUT):在对象模式下初始化的 OCI 环境句柄。
  • ref (IN/OUT):要清理的Ref。

其他说明

OCIRefFromHex

功能描述

将给定的十六进制字符串转换为 REF。

功能说明

将给定的十六进制字符串转换为 REF。此函数可确保生成的 REF 格式正确。它不能确保生成的 REF 指向的对象存在。

接口信息

函数/过程

OCIRefFromHex 语法如下:

sword OCIRefFromHex ( OCIEnv              *env, 
                      OCIError            *err, 
                      const OCISvcCtx     *svc, 
                      const OraText       *hex, 
                      ub4                  length, 
                      OCIRef             **ref );

具体参数解释如下:

  • env(IN/OUT):在对象模式下初始化的 OCI 环境句柄。
  • err(IN/OUT):OCI 错误句柄。如果存在错误,则会将其记录在 err 中,此函数返回OCI_ERROR。通过调用 OCIErrorGet() 获取诊断信息。
  • svc(IN):服务上下文句柄。
  • hex(IN):十六进制文本字符串,以前由 OCIRefToHex() 输出,用于转换为 REF。
  • Length(IN):输入的hex的长度
  • ref (IN/OUT):十六进制字符串转换为的 REF。如果 *ref 在输入时为 NULL,则在对象缓存中为 REF 分配空间;否则,将重用给定 REF 占用的内存。

其他说明

OCIRefHexSize

功能描述

返回 REF 的十六进制表示形式的大小。

功能说明

返回 REF 的十六进制表示形式的大小。必须将至少此大小的缓冲区传递给 ref-to-hex(OCIRefToHex()) 转换函数。

数据相关性

接口信息

函数/过程

OCIRefHexSize 语法如下:

ub4 OCIRefHexSize ( OCIEnv            *env,
                    const OCIRef      *ref );

参数的解释如下:

  • env(IN/OUT):在对象模式下初始化的 OCI 环境句柄。
  • ref (IN):返回大小以十六进制表示形式表示的 REF(以字节为单位)。

其他说明

OCIRefIsEqual

功能描述

比较两个 REF 以确定它们是否相等。

功能说明

当且仅当两个 REF 都引用同一对象(无论是持久对象还是瞬态对象)时,它们才相等。

注意:此函数认为两个空 REF 不相等。

接口信息

函数/过程

OCIRefIsEqual 语法如下:

boolean OCIRefIsEqual ( OCIEnv              *env,
                        const OCIRef        *x,
                        const OCIRef        *y );

具体参数解释如下:

  • env(IN/OUT):在对象模式下初始化的 OCI 环境句柄。

  • x(IN):参与比较的第一个Ref。

  • y(IN):参与比较的第二个Ref。

其他说明

OCIRefIsNull

功能描述

判断OCIRef是否为NULL。

功能说明

判断OCIRef是否为NULL。

数据相关性

接口信息

函数/过程

OCIRefIsNull 语法如下:

boolean OCIRefIsNull ( OCIEnv           *env,
                       const OCIRef     *ref );

参数的解释如下:

  • env(IN/OUT):在对象模式下初始化的 OCI 环境句柄。
  • ref (IN):输入的Ref。

其他说明

OCIRefToHex

功能描述

将REF 转换为十六进制字符串。

功能说明

将REF 转换为十六进制字符串。

接口信息

函数/过程

OCIRefToHex 语法如下:

sword OCIRefToHex ( OCIEnv            *env,
                    OCIError          *err, 
                    const OCIRef      *ref, 
                    OraText           *hex, 
                    ub4               *hex_length );

具体参数解释如下:

  • env(IN/OUT):在对象模式下初始化的 OCI 环境句柄。
  • err(IN/OUT):OCI 错误句柄。如果存在错误,则会将其记录在 err 中,此函数返回OCI_ERROR。通过调用 OCIErrorGet() 获取诊断信息。
  • ref (IN):要转换为十六进制字符串的 REF;如果 ref 是一个空的 REF(即 OCIRefIsNull(ref) == TRUE),则返回零hex_length值。
  • hex(OUT):缓冲区足够大,可以包含生成的十六进制字符串;字符串的内容对调用方是不透明的。
  • Length(IN/OUT):输入时,指定十六进制缓冲区的大小;在输出时,指定以十六进制返回的十六进制字符串的实际大小。

其他说明