DB Access Class Library for COBOL V1.0 API Reference - Microsoft(R) Windows(R) - - Microsoft(R) Windows NT(R) - - Microsoft(R) Windows(R) 2000 -

Contents Index

Chapter 6 DB Access Library API Reference

6.2 Methods

6.2.19 GET-NAME Method

Click the buttons shown below to scroll to class-specific explanations.

�¡Class

FJDB-SESSION-class

FJDB-DATABASE-class

FJDB-COMMAND-class

FJDB-RECORDSET-class

�Ÿ[FJDB-SESSION class]

�¡Function

Returns the identifier of an object of the FJDB-SESSION class.

�¡Syntax

INVOKE SESSION-A "GET-NAME" USING NAME NAME-SIZE RETURNING RET-CODE.

�¡Object identifier

SESSION-A [attribute:OBJECT REFERENCE FJDB-SESSION]

Specifies an object of the FJDB-SESSION class.

�¡Arguments

NAME [attribute:X(nn) nn is an area length]

Specifies the area in which the identifier is stored.

NAME-SIZE [attribute:�FS9(9) COMP-5]

Returns the length of the character string.

�¡Return value

RET-CODE [attribute:�FS9(9) COMP-5]

Returns a value of 0 if the method ends normally; otherwise, returns an error code.

�¡Explanation

Using the SET-NAME method makes it possible to assign an identifier to an object of the FJDB-SESSION class. For an object of the FJDB-SESSION class to which an identifier has not been assigned by the SET-NAME method, "Snnnnnnnn (n's being up to eight digits as internally assigned)" is returned as an identifier.

�Ÿ[FJDB-DATABASE class]

�¡Function

Returns the identifier of an object of the FJDB-DATABASE class. The database name specified in the OPEN-DATABASE method is returned.

�¡Syntax

INVOKE DATABASE-A "GET-NAME" USING NAME NAME-SIZE RETURNING RET-CODE.

�¡Object identifier

DATABASE-A [attribute:�FOBJECT REFERENCE FJDB-DATABASE]

Specifies an object of the FJDB-DATABASE class.

�¡Arguments

NAME [attribute:�FX(nn) nn is an area length]

Specifies the area in which the identifier is stored.

NAME-SIZE [attribute:�FS9(9) COMP-5]

Returns the length of the character string.

�¡Return value

RET-CODE [attribute:�FS9(9) COMP-5]

Returns a value of 0 if the method ends normally; otherwise, returns an error code.

�Ÿ[FJDB-COMMAND class]

�¡Function

Returns the identifier of an object of the FJDB-COMMAND class.

�¡Syntax

INVOKE COMMAND-A "GET-NAME" USING NAME NAME-SIZE RETURNING RET-CODE.

�¡Object identifier

COMMAND-A [attribute:�FOBJECT REFERENCE FJDB-COMMAND]

Specifies an object of the FJDB-COMMAND class.

�¡Arguments

NAME [attribute:�FX(nn) nn is an area length]

Specifies the area in which the identifier is stored.

NAME-SIZE [attribute:�FS9(9) COMP-5]

Returns the length of the character string.

�¡Return value

RET-CODE [attribute:�FS9(9) COMP-5]

Returns a value of 0 if the method ends normally; otherwise, returns an error code.

�¡Explanation

Using the SET-NAME method makes it possible to assign an identifier to an object of the FJDB-COMMAND class. For an object of the FJDB-COMMAND class to which an identifier has not been assigned by the SET-NAME method, "Snnnnnnnn (n's being up to eight digits as internally assigned)" is returned as an identifier.

�Ÿ[FJDB-RECORDSET class]

�¡Function

Returns the identifier of an object of the FJDB-RECORDSET class.

�¡Syntax

INVOKE RECORDSET-A "GET-NAME" USING NAME NAME-SIZE RETURNING RET-CODE.

�¡Object identifier

RECORDSET-A [attribute:�FOBJECT REFERENCE FJDB-RECORDSET]

Specifies an object of the FJDB-RECORDSET class.

�¡Arguments

NAME [attribute:�FX(nn) nn is an area length]

Specifies the area in which the identifier is stored.

NAME-SIZE [attribute:�FS9(9) COMP-5]

Returns the length of the character string.

�¡Return value

RET-CODE [attribute:�FS9(9) COMP-5]

Returns a value of 0 if the method ends normally; otherwise, returns an error code.

�¡Explanation

Using the SET-NAME method makes it possible to assign an identifier to an object of the FJDB-RECORDSET class. For an object of the FJDB-RECORDSET class to which an identifier has not been assigned by the SET-NAME method, "Snnnnnnnn (n's being up to eight digits as internally assigned)" is returned as an identifier.

Contents Index