DataBlade API Programmer's Manual

DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions

Home Contents Index Master Index New Book

mi_large_object_pin()

The mi_large_object_pin() function accesses data in a multirepresentational data type.

Syntax

#include "miloback.h"

...
void *mi_large_object_pin(conn, size, mrptr)

		MI_CONNECTION *conn;

		MI_MULTIREP_SIZE size;

		MI_MULTIREP_DATA *mrptr; 


conn
is a pointer to the connection descriptor that a previous call to mi_open() or mi_server_connect() has established.

size
is either MI_MULTIREP_SMALL or MI_MULTIREP_LARGE. 

mrptr
is a pointer to the data.







 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes

Usage

The mi_large_object_pin() function is typically invoked on entry to a user-defined function that must get a value from a multirepresentational data type. When the application is finished using the data, it should call mi_large_object_unpin() to release the object resources.

Use mi_large_object_unpin() to unpin this memory when it is no longer needed.

Return Values

On success, returns a pointer to the data in a multirepresentational type.

DataBlade API Programmer's ManualChapter 12: DataBlade API Function Descriptions Home Contents Index Master Index New Book

mi_large_object_pin()

Syntax

Usage

Return Values

Related Topics

DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions

Home Contents Index Master Index New Book