PBORCA_LibraryCommentModify
Description
Modifies the comment for a PowerBuilder library.
Syntax
|
1 2 3 |
INT PBORCA_LibraryCommentModify ( HPBORCA hORCASession, LPTSTR lpszLibName, LPTSTR lpszLibComments ); |
|
Argument |
Description |
|---|---|
|
hORCASession |
Handle to previously established ORCA |
|
lpszLibName |
Pointer to a string whose value is the name of the |
|
lpszLibComments |
Pointer to a string whose value is the new library |
Return value
INT. Typical return codes are:
|
Return code |
Description |
|---|---|
|
0 PBORCA_OK |
Operation successful |
|
-1 PBORCA_INVALIDPARMS |
Invalid parameter list |
|
-3 PBORCA_OBJNOTFOUND |
Library not found |
|
-4 PBORCA_BADLIBRARY |
Bad library name |
|
-7 PBORCA_LIBIOERROR |
Library I/O error |
Usage
You don’t need to set the library list or current application before
calling this function.
Examples
This example changes the comments for the library MASTER.PBL:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
LPTSTR pszLibraryName; LPTSTR pszLibraryComments; // Specify library name and comment string pszLibraryName = _TEXT("c:\appeon\pb2019\demo\master.pbl"); pszLibraryComments = _TEXT("PBL contains ancestor objects for XYZ app."); // Insert comments into library lpORCA_Info->lReturnCode = PBORCA_LibraryCommentModify( lpORCA_Info->hORCASession, pszLibraryName, pszLibraryComments); |
In these examples, session information is saved in the data
structure ORCA_Info, shown in About the examples.
See also