PBORCA_LibraryDelete

Description

Deletes a PowerBuilder library file from disk.

Syntax

INT PBORCA_LibraryDelete ( HPBORCA hORCASession, 
           LPTSTR
      lpszLibraryName );

Argument

Description

hORCASession

Handle to previously established ORCA session

lpszLibraryName

Pointer to a string whose value is the file name of the library to be deleted


Return value

INT. Typical return codes are:

Return code

Description

0       PBORCA_OK

Operation successful

-1      PBORCA_INVALIDPARMS

Invalid parameter list

-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. You must set the eClobber configuration property to PBORCA_CLOBBER_ALWAYS if you want to delete a PowerBuilder library that has a read-only attribute.

Examples

This example deletes a library called EXTRA.PBL:

LPTSTR pszLibraryName;
// Specify library name
pszLibraryName = 
   _TEXT("c:\\appeon\\pb2017\\demo\\extra.pbl");
 
// Delete the Library
lpORCA_Info->lReturnCode =
   PBORCA_LibraryDelete(lpORCA_Info->hORCASession,
   pszLibraryName);

In these examples, session information is saved in the data structure ORCA_Info, shown in About the examples.

See also

PBORCA_ConfigureSession

PBORCA_LibraryCreate