MemCom Reference Manual > MemCom ftn Fortran API > Dynamic Memory Manager (DMM) > mcf_dmm_get_set

Name

mcf_dmm_get_set — Load data set in Dynamic Memory

Synopsis

subroutine mcf_dmm_get_set(handle,name,type,size,
ident,status)

subroutine mcf_dmm_get_subset(handle,name,type,idiv,size,
ident,status)

subroutine mcf_dmm_get_set_pos(handle,name,type,pos,size,
ident,status)

integer*4 handle
character*(*) name
character*4 type
mcf_size size
mcf_site pos
integer*4 ident
integer*4 status

Description

mcf_dmm_get_set loads the entire dataset name from a database file identified by handle in Dynamic Memory and returns the DMM identifier ident. mcf_dmm_get_subset loads the sub-set idiv of the dataset name from a database file identified by handle in Dynamic Memory and returns the DMM identifier ident. The mcf_dmm_get functions work for data arrays of type I, J, E, F, C, or Z. The address of the set in Dynamic Memory can be retrieved with the dmmptr function. Any dataset with the same name and database unit identifier already residing in Dynamic Memory will be overwritten. If this is not desired, remove the dataset in DMM with mcf_dmm_delete.

[Note]Note

In contrast to the old f77 API functions dmmget and dmmload, these functions will overload any existing dataset with the same name and handle already residing in Dynamic Memory, i.e all data of the dataset in Dynamic Memory will be overwritten.

Parameters

handle

Handle of database file on which the set resides (input).

name

Name of dataset to be read from the database file (input). The string may not exceed the maximum dataset name length.

type

Data type of array to be loaded (input). Must be one of I, J, E, F; C, or Z.

idiv

Subset index (input). idiv must be in the range of 1 to the number of subset (row) in the dataset.

size

Number of data elements to be read (input).

pos

Position relative to the beginning of the set from which data are being read (input). Positions start with the index 1.

ident

DMM identifier returned by the function (output). In case of an error ident remains undefined.

status

Status code returned (output). Upon successful completion of the operation, the status value 0 is returned. A negative value is returned if an error has been detected. A positive value is returned if a warning has been issued.