ORCA Guide

Appeon PowerBuilder® 2019

FOR WINDOWS

DOCUMENT ID: DC37664-01-1900-01

LAST REVISED: February 20, 2019

Copyright © 2019 Appeon. 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 described herein is furnished under a license agreement, and it may be used or copied only in accordance with the terms of that agreement.

Upgrades are provided only at regularly scheduled software release dates. No part of this publication may be reproduced, transmitted, or translated in any form or by any means, electronic, mechanical, manual, optical, or otherwise, without the prior written permission of Appeon Inc.

Appeon and other Appeon products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Appeon Inc.

SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP and SAP affiliate company.

Java and all Java-based marks are trademarks or registered trademarks of Oracle and/or its affiliates in the U.S. and other countries.

Unicode and the Unicode Logo are registered trademarks of Unicode, Inc.

All other company and product names mentioned may be trademarks of the respective companies with which they are associated.

Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of DFARS 52.227-7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for civilian agencies.

Appeon Inc., 1/F, Shell Industrial Building, 12 Lee Chung Street, Chai Wan District, Hong Kong.


Table of Contents

Using ORCA
What is ORCA?
What can ORCA do?
Who can develop programs that call ORCA?
Installing ORCA
ORCA and the Library painter
Objects in a PowerBuilder library
Object source code
PowerBuilder commands and ORCA functions
About ORCA functions
Functions for managing the ORCA session
Functions for managing PowerBuilder libraries
Functions for importing and compiling PowerBuilder objects
Functions for querying PowerBuilder objects
Functions for creating executables and dynamic libraries
Functions for deploying components to EAServer (Obsolete)
Functions for managing source control operations
About ORCA callback functions
ORCA functions that use callbacks
How a callback works
Content of a callback function
Writing ORCA programs
Outline of an ORCA program
Bootstrapping a new application
Removing obsolete ORCA functions
ORCA Functions
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
ORCA Callback Functions and Structures
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