PBORCA_LibraryEntryDelete

Description

Deletes a PowerBuilder library entry.

Syntax

INT PBORCA_LibraryEntryDelete (HPBORCA hORCASession, 
   LPTSTR lpszLibName, 
   LPTSTR lpszEntryName, 
   PBORCA_TYPE otEntryType );

Argument

Description

hORCASession

Handle to previously established ORCA session.

lpszLibName

Pointer to a string whose value is the file name of the library containing the object.

lpszEntryName

Pointer to a string whose value is the name of the object being deleted.

otEntryType

A value of the PBORCA_TYPE enumerated data type specifying the object type of the entry being deleted. Values are:

PBORCA_APPLICATION

PBORCA_DATAWINDOW

PBORCA_FUNCTION

PBORCA_MENU

PBORCA_QUERY

PBORCA_STRUCTURE

PBORCA_USEROBJECT

PBORCA_WINDOW

PBORCA_PIPELINE

PBORCA_PROJECT

PBORCA_PROXYOBJECT


Return value

INT. Typical return codes are:

Return code

Description

0       PBORCA_OK

Operation successful

-1      PBORCA_INVALIDPARMS

Invalid parameter list

-3      PBORCA_OBJNOTFOUND

Object not found

-4      PBORCA_BADLIBRARY

Bad library name

-7      PBORCA_LIBIOERROR

Library I/O error


Usage

You do not need to set the library list or current application before calling this function.

Examples

This example deletes a DataWindow named d_labels from the library SOURCE.PBL:

lrtn = PBORCA_LibraryEntryDelete(
   lpORCA_Info->hORCASession,
   _TEXT("c:\\app\\source.pbl"),
   _TEXT("d_labels"), PBORCA_DATAWINDOW);

This example assumes that the pointers lpszLibraryName and lpszEntryName point to valid library and object names and that otEntryType is a valid object type:

lpORCA_Info->lReturnCode = PBORCA_LibraryEntryDelete(
   lpORCA_Info->hORCASession,
   lpszLibraryName, 
   lpszEntryName, 
   otEntryType);

See also

PBORCA_LibraryEntryCopy

PBORCA_LibraryEntryMove