Powerbuilder Orca Guide

ORCA Guide – PB Docs 2017

ORCA Guide Appeon PowerBuilder® 2017 R3 FOR WINDOWS DOCUMENT ID: DC37664-01-1700-01 LAST REVISED: July 13, 2018 Copyright © 2018 by Appeon Limited. All rights reserved. This publication pertains to Appeon software and to any subsequent release until otherwise indicated in new editions or technical notes. Information in this document is subject to change without notice. The software…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

ORCA Callback Functions and Structures – PB Docs 2017

ORCA Callback Functions and Structures Contents Callback function for compiling objects PBORCA_COMPERR structure Callback function for deploying components to EAServer (Obsolete) PBORCA_BLDERR structure Callback function for PBORCA_LibraryDirectory PBORCA_DIRENTRY structure Callback function for PBORCA_ObjectQueryHierarchy PBORCA_HIERARCHY structure Callback function for PBORCA_ObjectQueryReference PBORCA_REFERENCE structure Callback function for PBORCA_ExecutableCreate PBORCA_LINKERR structure Callback function for PBORCA_SccSetTarget PBORCA_SCCSETTARGET structure About this…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

PBORCA_LibraryDirectory – PB Docs 2017

PBORCA_LibraryDirectory Description Reports information about the directory of a PowerBuilder library, including the list of objects in the directory. Syntax

INT PBORCA_LibraryDirectory ( HPBORCA hORCASession, 
   LPTSTR lpszLibName, 
   LPTSTR lpszLibComments, 
   INT iCmntsBuffLen, 
   PBORCA_LISTPROC pListProc, 
   LPVOID pUserData );

INT PBORCA_LibraryDirectory ( HPBORCA hORCASession,

LPTSTR lpszLibName,

LPTSTR lpszLibComments,

INT iCmntsBuffLen,

PBORCA_LISTPROC pListProc,

LPVOID pUserData );

Argument Description hORCASession Handle to previously established ORCA session. lpszLibName Pointer to a string whose value is the file name of the library for which you want directory information. lpszLibComments Pointer to a buffer…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

PBORCA_SccGetLatestVersion – PB Docs 2017

PBORCA_SccGetLatestVersion Description Retrieves the latest version of files from the SCC provider. Syntax

INT PBORCA_SccGetLatestVer ( HPBORCA hORCASession, 
   Long nFiles, 
   LPTSTR *ppFileNames );

INT PBORCA_SccGetLatestVer ( HPBORCA hORCASession,

Long nFiles,

LPTSTR *ppFileNames );

Argument Description hORCASession Handle to previously established ORCA session nFiles Number of files to be retrieved *ppFileNames Names of files to be retrieved Return value INT. Typical return codes are: Return code Description 0 PBORCA_OK Operation successful -22 PBORCA_SCCFAILURE Operation failure Usage…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

PBORCA_SccExcludeLibraryList – PB Docs 2017

PBORCA_SccExcludeLibraryList Description Names the libraries in the target library list that should not be synchronized in the next PBORCA_SccRefreshTarget operation. Syntax

INT PBORCA_SccExcludeLibraryList ( HPBORCA hORCASession, 
   LPTSTR *pLibNames,
   INT iNumberofLibs );

INT PBORCA_SccExcludeLibraryList ( HPBORCA hORCASession,

LPTSTR *pLibNames,

INT iNumberofLibs );

Argument Description hORCASession Handle to previously established ORCA session *pLibNames Names of the libraries not to be refreshed iNumberofLibs Number of libraries not to be refreshed Return value INT. Usage This method is…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

ORCA Functions – PB Docs 2017

ORCA Functions Contents About the examples ORCA return codes PBORCA_ApplicationRebuild PBORCA_BuildProject PBORCA_BuildProjectEx PBORCA_BuildProjectWithOverrides PBORCA_CompileEntryImport PBORCA_CompileEntryImportList PBORCA_CompileEntryRegenerate PBORCA_ConfigureSession PBORCA_DeployWinFormProject PBORCA_DynamicLibraryCreate PBORCA_ExecutableCreate PBORCA_LibraryCommentModify PBORCA_LibraryCreate PBORCA_LibraryDelete PBORCA_LibraryDirectory PBORCA_LibraryEntryCopy PBORCA_LibraryEntryDelete PBORCA_LibraryEntryExport PBORCA_LibraryEntryExportEx PBORCA_LibraryEntryInformation PBORCA_LibraryEntryMove PBORCA_ObjectQueryHierarchy PBORCA_ObjectQueryReference PBORCA_SccClose PBORCA_SccConnect PBORCA_SccConnectOffline PBORCA_SccExcludeLibraryList PBORCA_SccGetConnectProperties PBORCA_SccGetLatestVersion PBORCA_SccRefreshTarget PBORCA_SccResetRevisionNumber PBORCA_SccSetTarget PBORCA_SessionClose PBORCA_SessionGetError PBORCA_SessionOpen PBORCA_SessionSetCurrentAppl PBORCA_SessionSetLibraryList PBORCA_SetDebug PBORCA_SetExeInfo About this chapter This chapter documents the…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

PBORCA_ObjectQueryReference – PB Docs 2017

PBORCA_ObjectQueryReference Description Queries a PowerBuilder object to get a list of its references to other objects. Syntax

INT PBORCA_ObjectQueryReference ( HPBORCA hORCASession, 
   LPTSTR lpszLibraryName, 
   LPTSTR lpszEntryName, 
   PBORCA_TYPE otEntryType, 
   PBORCA_REFPROC pRefProc, 
   LPVOID pUserData );

INT PBORCA_ObjectQueryReference ( HPBORCA hORCASession,

LPTSTR lpszLibraryName,

LPTSTR lpszEntryName,

PBORCA_TYPE otEntryType,

PBORCA_REFPROC pRefProc,

LPVOID pUserData );

Argument Description hORCASession Handle to previously established ORCA session. lpszLibraryName Pointer to a string whose value is the file name of the library containing the object being queried. lpszEntryName Pointer to a string whose value is the…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

PBORCA_SccRefreshTarget – PB Docs 2017

PBORCA_SccRefreshTarget Description Calls SccGetLatestVersion to refresh the source for each of the objects in the target libraries. Syntax

INT PBORCA_SccRefreshTarget ( HPBORCA hORCASession, PBORCA_REBLD_TYPE eRebldType );

1	INT PBORCA_SccRefreshTarget ( HPBORCA hORCASession, PBORCA_REBLD_TYPE eRebldType );

Argument Description hORCASession Handle to previously established ORCA session eRebldType Allows you to specify how the application is rebuilt (see Usage section below) Return value INT. Usage Call this method to get the latest version of…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

PBORCA_COMPERR structure – PB Docs 2017

PBORCA_COMPERR structure Description Reports information about an error that occurred when you tried to import and compile objects in a library. The following functions pass the PBORCA_COMPERR structure to their callback functions: PBORCA_CompileEntryImport PBORCA_CompileEntryImportList PBORCA_CompileEntryRegenerate Syntax

typedef struct pborca_comperr {
   int iLevel;
   LPTSTR lpszMessageNumber;
   LPTSTR lpszMessageText;
   UINT iColumnNumber;
   UINT iLineNumber;
} PBORCA_COMPERR, FAR *PPBORCA_COMPERR;

typedef struct pborca_comperr {

int iLevel;

LPTSTR lpszMessageNumber;

LPTSTR lpszMessageText;

UINT iColumnNumber;

UINT iLineNumber;

} PBORCA_COMPERR, FAR *PPBORCA_COMPERR;

Member Description iLevel Number identifying the severity of the error. Values are: 0 — Context information, such as…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

Callback function for PBORCA_ObjectQueryReference – PB Docs 2017

Callback function for PBORCA_ObjectQueryReference Description Called for each referenced object in the object being examined. In the callback function, you can save the name of the referenced object for later display. Syntax

typedef void (CALLBACK *PBORCA_REFPROC)
              ( PPBORCA_REFERENCE, LPVOID );

1 2	typedef void (CALLBACK *PBORCA_REFPROC) ( PPBORCA_REFERENCE, LPVOID );

Argument Description PPBORCA_REFERENCE Pointer to the PBORCA_REFERENCE structure (described next) LPVOID Long pointer to user data Return value None. Usage You provide the…

Powerbuilder Documentation 2017 PB Docs 2017 Powerbuilder Documentation 2017 Powerbuilder Orca Guide

Connection Information

ORCA Guide – PB Docs 2017

ORCA Callback Functions and Structures – PB Docs 2017

PBORCA_LibraryDirectory – PB Docs 2017

PBORCA_SccGetLatestVersion – PB Docs 2017

PBORCA_SccExcludeLibraryList – PB Docs 2017

ORCA Functions – PB Docs 2017

PBORCA_ObjectQueryReference – PB Docs 2017

PBORCA_SccRefreshTarget – PB Docs 2017

PBORCA_COMPERR structure – PB Docs 2017

Callback function for PBORCA_ObjectQueryReference – PB Docs 2017

My Website Links