HP-UX SNAplus2 CSV Programmer’s Guide HP-UX 11i Edition 2 Manufacturing Part Number: J2744-90017 E0603 United States © Copyright 2003 © Hewlett-Packard Company, 2003. All rights reserved.
Legal Notices The information in this document is subject to change without notice. Hewlett-Packard makes no warranty of any kind with regard to this manual, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Hewlett-Packard shall not be held liable for errors contained herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance, or use of this material.
Trademark Notices ActivePerl is a registered trademark of ActiveState Tool Corporation Apple and Macintosh are trademarks of Apple Computer, Inc., registered in the United States and other countries. AppleShare is a registered trademark of Apple Computer, Inc. CHAMELEON is a trademark of NetManage, Inc. DIGITAL and PATHWORKS are trademarks of Digital Equipment Corporation. DiskAccess is a registered trademark of Intergraph. EXCURSION is a trademark of Digital Equipment Corporation.
SunForum is a registered trademark of Sun Microsystems, Inc. in the United States and other countries. UNIX is a registered trademark in the United States and other countries, licensed exclusively through The Open Group. VERITAS is a registered trademark of VERITAS Software Corporation. VERITAS File System is a trademark of VERITAS Software Corporation. WinDD is a trademark of Tektronix, Inc. X Window System is a trademark of the Massachusetts Institute of Technology.
Contents 1. Concepts Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common Service Verbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CSV Entry Points: HP-UX Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents VCB Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supplied Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returned Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SNACTL Environment Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GET_CP_CONVERT_TABLE . . . .
Publishing History The manual publishing date and part number indicate its current edition. The publishing date will change when a new edition is published. Minor changes may be made without changing the publishing date. The manual part number will change when extensive changes are made. Manual updates may be issued between editions to correct errors or document product changes. To ensure that you receive the updated or new editions, you should subscribe to the appropriate product support service.
Preface This book is a guide for using the SNAplus2 Common Service Verbs (CSVs) in C-language application programs. This book applies to Release 6.2 of SNAplus2.
Audience The primary audience for this manual is the programmer writing application programs that use Common Service Verbs. Prerequisite Knowledge Before reading this manual, you should have knowledge of the following subjects: • The C compiler cc • HP-UX version 10.0 or later OR 10 • The Microsoft Visual C++ Version 4 compiler • Microsoft Windows NT (Version 3.
Organization of This Book This book is organized as follows: Chapter 1, “Concepts.” Summarizes Common Service Verbs and explains how to use them in C programs. Chapter 2, “Common Service Verbs Reference.” Describes each verb in detail. Each description includes the verb's purpose, verb control block (VCB), and supplied and returned parameters.
Typographic Conventions The following table shows the typographic styles used in this document. Table 1 12 Typographic Conventions Special Element Sample of Typography Document title HP-UX SNAplus2 Administration Guide File or path name acssvcc.
Operating System-Specific Information Some sections of text are marked as applying only to the HP-UX operating system or only to Windows, which means the 32-bit Win32 client that runs on the Microsoft NT (Version 3.51 or later) and Windows 95 operating systems. SNAplus2 also provides a Win16 client which runs on Microsoft Windows 3.1 and Windows for Workgroups 3.11, but the Win16 client is not documented in this book.
SNAplus2 Publications SNAplus2 publications include user guides, administrator guides, and programmer guides. The following sections describe the contents of each book. Publications for Users SNAplus2 provides the following user’s guides: HP-UX SNAplus2 General Information Provides an introduction to SNAplus2 and explains key product concepts and features.
HP-UX SNAplus2 Upgrade Guide Provides information about upgrading to the current version of SNAplus2 from previous versions. It includes information about converting configuration files, rebuilding applications that use the SNAplus2 application program interfaces (APIs), and changes in other SNAplus2 functions. HP-UX SNAplus2 Administration Guide Explains how to enable, configure, and manage SNAplus2. This guide provides information about SNA concepts, and an overview of the features provided by SNAplus2.
HP-UX SNAplus2 LUA Programmers Guide Contains the information you need to write applications using the Conventional LU Application Programming Interface (LUA). HP-UX SNAplus2 CSV Programmers Guide (this guide) Contains the information you need to write application programs using the Common Service Verbs (CSV) application program interface (API). HP-UX SNAplus2 MS Programmers Guide Contains the information you need to write applications using the Management Services (MS) API.
1 Chapter 1 Concepts 17
Concepts Overview Overview This chapter provides information that you need to know when developing CSV application programs.
Concepts Summary Summary Common Service Verbs This section briefly describes Common Service Verbs. Chapter 2, “Common Service Verbs Reference,” contains a detailed description of each verb. CONVERT Converts a character string from ASCII to EBCDIC or from EBCDIC to ASCII. COPY_TRACE_TO_FILE (HP-UX Only) Copies the current contents of the trace file (or files) to another file for storage. DEFINE_TRACE (HP-UX Only) Enables or disables tracing for specific Application Program Interfaces (APIs).
Concepts Summary For Windows systems, the verb builds a Systems Network Architecture (SNA) request unit (RU) containing Network Management Vector Transport (NMVT) data. The verb can send the NMVT data to NetView for centralized problem diagnosis and resolution. The data can also be logged in the local error log file.
Concepts CSV Entry Points: HP-UX Systems CSV Entry Points: HP-UX Systems A C program calls Common Service Verbs through the following entry point: void ACSSVC_C ( void * vcbptr ); The only parameter passed to the function is the address of a verb control block (VCB). The VCB is a structure made up of variables that identify the verb to be executed, supply information to be used by the verb, and contain information returned by the verb when execution is complete.
Concepts CSV Entry Points: Windows CSV Entry Points: Windows A Windows application accesses CSV using the following functions: ACSSVC_C Issues a verb. The verb blocks; that is, the application's thread is suspended until CSV has finished processing the verb and returned the results. This has the same effect as WinCSV. WinCSVStartup Registers the application as a Windows CSV user, and determines whether the CSV software supports the level of function required by the application. WinCSV Issues a verb.
Concepts CSV Entry Points: Windows returns with return codes that indicate an error, the application can use GetCsvReturnCode to obtain a text string representation of these return codes, which can be used to generate standard error messages. When the application has finished issuing verbs using the WinCSV or WinAsyncCSV calls, it must call WinCSVCleanup before terminating; it must not attempt to issue any more verbs after calling WinCSVCleanup. The following sections describe these functions.
Concepts CSV Entry Points: Windows WinCSVStartup The application uses this function to register as a Windows CSV user, and to determine whether the CSV software supports the Windows CSV version that it requires. Function Call int WINAPI LOADDS WinCSVStartup ( WORD WCSVDATA far * ); wVersionRequired, lpData typedef struct { WORD wVersion; char szDescription[128]; } WCSVDATA; Supplied Parameters The supplied parameter is: wVersionRequired The version of Windows CSV that the application requires.
Concepts CSV Entry Points: Windows 0 (zero) The application was registered successfully, and the Windows CSV software supports either the version number specified by the application or a lower version. The application should check the version number in the WCSVDATA structure to ensure that it is high enough. WCSVVERNOTSUPPORTED The version number specified by the application was lower than the lowest version supported by the Windows CSV software. The application was not registered.
Concepts CSV Entry Points: Windows attempt to use features that are not supported by the returned version number. If it cannot do this because it requires features not available in the lower version, it should fail its initialization and not attempt to issue any CSV verbs. szDescription A text string describing the Windows CSV software. WinCSV The application uses this function to issue a verb, which blocks until verb processing is completed.
Concepts CSV Entry Points: Windows Before using the WinAsyncCSV call for the first time, the application must use RegisterWindowMessage to obtain the message identifier that CSV will use for messages indicating asynchronous verb completion. For more information, see “Windows Considerations”.
Concepts CSV Entry Points: Windows Usage Before using WinAsyncCSV for the first time, the application must use the RegisterWindowMessage call to obtain the message identifier that CSV will use for messages indicating asynchronous verb completion. RegisterWindowMessage is a standard Windows function call, not specific to CSV; refer to your Windows documentation for more information about the function.
Concepts CSV Entry Points: Windows FALSE An error occurred during processing of the call, and the application was not unregistered. Check the log files for messages indicating the cause of the failure. GetCsvReturnCode This call returns a printable character string interpreting the return codes from a supplied VCB. The string can be used to generate application error messages for return codes other than AP_OK. This call is designed to provide strings for display to the end user of an application.
Concepts CSV Entry Points: Windows buffer_length The length (in bytes) of the buffer supplied by the application to hold the returned data string. The recommended length is 256 bytes. buffer_addr The address of the buffer supplied by the application to hold the returned data string. Returned Values The return value from the function is one of the following: 0x00000000 The function completed successfully.
Concepts Issuing a Verb Issuing a Verb The major steps in issuing a Common Service Verb follow. Each step is illustrated by sample code pertaining to the CONVERT verb; for more information about this verb, see Chapter 2, “Common Service Verbs Reference.” Step 1. Create a structure variable from the VCB structure that applies to the verb to be issued. #include . . . struct convert conv_block; For Windows, replace acssvcc.h with wincsv.h, the name of the Windows CSV header file.
Concepts Issuing a Verb conv_block.source = (char far *) tpstart_name; conv_block.target = (char far *) tpstart.tp_name; The fields SV_CONVERT, SV_ASCII_TO_EBCDIC, and SV_AE are symbolic constants representing integers. These constants are defined in the CSV header file. The character array tpstart_name contains an ASCII string to be converted to EBCDIC and placed in the character array tpstart.tp_name. Step 4. Invoke the verb.
Concepts HP-UX System Considerations HP-UX System Considerations This section summarizes the information you need to consider when developing applications for use in the HP-UX environment. Back Level Applications New applications will use dynamic libraries in /opt/sna/lib/hpux32 or /opt/sna/lib/hpux64 as described above. SNAplus2 release 6.2 also includes a set of dynamic libraries to support existing applications that have been built with previous versions of SNAplus or SNAplus2 on PA-Risc systems.
Concepts HP-UX System Considerations NOTE A compatible version of the libraries is supplied so that existing applications continue to work. In this case the restriction that applied to these libraries still apply as documented in the SNAplus2 Release 5 SNAplus2 CSV Programmers Guide. Compiling and Linking the CSV Application Applications are compiled with different options in order to select one of the scheduling modes described in “Multithreaded Applications”.
Concepts HP-UX System Considerations • For HP-UX 10.20 (only DCE threads are supported), link with the following options: -L /opt -lcsv -lmgrdce -ldce • For HP-UX 11.0 using DCE threads, link with the following options: -L /opt -lcsv -lsna -ldce • For HP-UX 11.
Concepts Windows Considerations Windows Considerations This section summarizes processing considerations you need to be aware of when developing applications on a Windows client. Compiling and Linking a CSV Application This section provides information about compiling and linking CSV programs on Windows. Compiler Options for Structure Packing The VCB structures for CSV are not packed. Do not use compiler options that change this packing method.
Concepts Writing Portable Applications Writing Portable Applications The following guidelines are provided for writing SNAplus2 applications so that they will be portable to other environments: Chapter 1 • Include the CSV header file without any path name prefix. Use include options on the compiler to locate the file (refer to the appropriate section for your operating system, earlier in this chapter) This enables the application to be used in an environment with a different file system.
Concepts Writing Portable Applications 38 Chapter 1
2 Chapter 2 Common Service Verbs Reference 39
Common Service Verbs Reference Overview Overview This chapter contains a description of each of the Common Service Verbs. The following information is provided for each verb: • Definition of the verb. • Structure defining the verb control block (VCB) used by the verb. The structure is declared in the CSV header file. • Parameters (VCB fields) supplied for and returned by the verb.
Common Service Verbs Reference CONVERT CONVERT The CONVERT verb translates an ASCII character string to EBCDIC or an EBCDIC character string to ASCII. The string to be converted is called the source string. The converted string is called the target string.
Common Service Verbs Reference CONVERT SV_EBCDIC_TO_ASCII Convert from EBCDIC to ASCII characters. char_set Specifies which character set to use in converting the source string. Possible values are: SV_A The type-A character set consists of the following: • Uppercase letters • Numerals 0–9 • Special characters $, #, @, and space This character set is supported by a system-supplied type-A conversion table.
Common Service Verbs Reference CONVERT The first character of the source string can be any character in the character set. Spaces are allowed only in trailing positions, unless the string consists entirely of spaces. No case conversion is performed. SV_G The type-G character set is defined by a user-written conversion table. This table is described in detail under “Creating a Type-G Conversion Table”.
Common Service Verbs Reference CONVERT This is described in the HP-UX SNAplus2 Administration Guide. Set this parameter to the full path name of the file. (If the file is not found, the system returns the SV_TABLE_ERROR return code.) len The number of characters to be converted. source Address of buffer containing character string to be converted. target Address of buffer to contain the converted character string. This buffer can overlap or coincide with the buffer pointed to by the source parameter.
Common Service Verbs Reference CONVERT One or more characters in the source string were not found in the conversion table, or embedded spaces were found in a type-A or type-AE string. These characters or spaces were converted to nulls (0x00). The verb still executed. SV_INVALID_CHARACTER_SET The char_set parameter contained a value that is not valid.
Common Service Verbs Reference CONVERT • For Win16 clients, the file containing the table must be specified by the CSVTBLG parameter in the [CSV_data] section of the sna.ini file, as described in the HP-UX SNAplus2 Administration Guide. • For Win32 clients, the file containing the table must be specified by the CSVTBLG value Registry Key as follows: \\HKEY_LOCAL_MACHINE\SOFTWA RE\SNA Client\SxClient\Parameters\ CSV_data This is described in the HP-UX SNAplus2 Administration Guide.
Common Service Verbs Reference CONVERT The operating system has encountered an error while processing the verb. The operating system return code is returned through the secondary_rc. If the problem persists, consult the System Administrator for corrective action. For the meaning of the operating system return code, see the file /usr/include/errno.h (HP-UX systems) or to your operating system documentation (Windows systems).
Common Service Verbs Reference CONVERT 00000000000000000000000000000000 000102030009007F0000000B0C0D0E0F 101112130000080018190000001D001F 00001C00000A171B0000000000050607 00001600001E0004000000001415001A 20000000000000000000002E3C282B00 2600000000000000000021242A293B5E 2D2F00000000000000007C2C255F3E3F 000000000000000000603A2340273D22 00616263646566676869000000000000 006A6B6C6D6E6F707172000000000000 007E737475767778797A0000005B0000 000000000000000000000000005D0000 7B414243444546474849000000000000 7D4A4B4C4D4
Common Service Verbs Reference COPY_TRACE_TO_FILE (HP-UX Systems Only) COPY_TRACE_TO_FILE (HP-UX Systems Only) The COPY_TRACE_TO_FILE verb copies the current contents of the API trace file or files to a new file, and clears the trace files. This enables you to save a copy of the current trace data for this application. For more information about API tracing, refer to the HP-UX SNAplus2 Diagnostics Guide.
Common Service Verbs Reference COPY_TRACE_TO_FILE (HP-UX Systems Only) file_option Possible values are: SV_NEW Create a new file with the name specified in file_name. An error is returned if this file already exists. SV_OVERWRITE Overwrite the file if it exists, or create the file if it does not exist. Returned Parameters After the verb executes, SNAplus2 returns parameters to indicate whether the execution was successful and, if not, to indicate the reason the execution was unsuccessful.
Common Service Verbs Reference COPY_TRACE_TO_FILE (HP-UX Systems Only) There was no trace information to copy to file. Either the trace files were empty, or the SNATRC environment variable was not set up. This environment variable must be set up before the application is started. For information about how to control API tracing, refer to the HP-UX SNAplus2 Diagnostics Guide. SV_TRACE_NOT_STOPPED Tracing was still active when the verb was issued.
Common Service Verbs Reference COPY_TRACE_TO_FILE (HP-UX Systems Only) The operating system has encountered an error while processing the verb. The operating system return code is returned through the secondary_rc. If the problem persists, consult the System Administrator for corrective action. For the meaning of the operating system return code, refer to the file /usr/include/errno.h.
Common Service Verbs Reference DEFINE_TRACE (HP-UX Systems Only) DEFINE_TRACE (HP-UX Systems Only) The DEFINE_TRACE verb enables or disables tracing for specified Application Program Interfaces (APIs). The trace files must be set up before the application which issues this verb is started, using the SNATRC environment variable. For information about how to control API tracing, refer to the HP-UX SNAplus2 Diagnostics Guide.
Common Service Verbs Reference DEFINE_TRACE (HP-UX Systems Only) unsigned unsigned unsigned unsigned }; short char char char strg_size; reserv8[1]; phys_link[8]; reserv9[56]; /* /* /* /* Reserved. Reserved. Reserved. Reserved. */ */ */ */ Supplied Parameters The program using this verb supplies the following parameters: opcode SV_DEFINE_TRACE dt_set Specifies whether the DEFINE_TRACE verb is being used to turn tracing on or to turn tracing off.
Common Service Verbs Reference DEFINE_TRACE (HP-UX Systems Only) SNAplus2 checks only the most significant bit (bit 0) of this byte; other bits are ignored. To enable or disable tracing for the NOF API, depending on the dt_set parameter, set the most significant bit of this byte to 1. To leave tracing in its current state for the NOF API, set the most significant bit of this byte to zero. comm_serv Specifies whether the state of tracing for the Common Service Verbs (on or off) is to be changed.
Common Service Verbs Reference DEFINE_TRACE (HP-UX Systems Only) To enable or disable tracing for the MS API, depending on the dt_set parameter, set the most significant bit of this byte to 1. To leave tracing in its current state for the MS API, set the most significant bit of this byte to zero. rui Specifies whether the state of tracing for the RUI interface of LUA (on or off) is to be changed. SNAplus2 checks only the most significant bit (bit 0) of this byte; other bits are ignored.
Common Service Verbs Reference DEFINE_TRACE (HP-UX Systems Only) Unsuccessful Execution When a verb does not execute successfully, SNAplus2 returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.
Common Service Verbs Reference DEFINE_TRACE (HP-UX Systems Only) error occurs). This can be used to force tracing of a program which normally turns tracing off, or to suppress tracing of a program which normally uses it. For more information about tracing and on this environment variable, refer to the HP-UX SNAplus2 Administration Guide.
Common Service Verbs Reference GET_CP_CONVERT_TABLE GET_CP_CONVERT_TABLE The GET_CP_CONVERT_TABLE verb creates and returns a 256-byte conversion table to translate character strings from a source code page to a target code page. If a character from the source code page does not exist in the target code page, the translated (target) string differs from the original (source) string. A code page is a table that associates specific ASCII or EBCDIC values with specific characters.
Common Service Verbs Reference GET_CP_CONVERT_TABLE SV_GET_CP_CONVERT_TABLE source_cp Source code page (from which characters are converted). A decimal number which identifies the code page to be used. For a list of valid code page numbers, see “Supported Code Pages”. target_cp Target code page (to which characters are converted). A decimal number which identifies the code page to be used. For a list of valid code page numbers, see “Supported Code Pages”.
Common Service Verbs Reference GET_CP_CONVERT_TABLE Store a substitute character (specified by the substitute_char parameter) in the conversion table. Converting the translated character string back to the original code page will not necessarily recreate the original character string. substitute_char Specifies the character to store in the conversion table when a character from the source code page has no equivalent in the target code page.
Common Service Verbs Reference GET_CP_CONVERT_TABLE Unsuccessful Execution When a verb does not execute successfully, SNAplus2 returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.
Common Service Verbs Reference GET_CP_CONVERT_TABLE The operating system has encountered an error while processing the verb. The operating system return code is returned through the secondary_rc. If the problem persists, consult the System Administrator for corrective action. For the meaning of the operating system return code, refer to the file /usr/include/errno.h (HP-UX systems) or to your operating system documentation (Windows systems).
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) LOG_MESSAGE (HP-UX Systems Only) The LOG_MESSAGE verb records a message in the SNAplus2 error or audit log file. The text for the message is taken from a user-defined message file; the verb can also supply parameters to be inserted in the message. If you use this verb, you will need to supply an appropriate message file for use with the application. For more information, see “Creating a Log Message File”.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) parameter gives the message number; the component identifier for a message logged by this verb is always 32,767. origntr_id Name of the component issuing the LOG_MESSAGE verb; a string of up to eight characters. This parameter is optional; set the first byte to 0x00 if you do not want to include it.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) appropriate category; use the values SV_PROBLEM, SV_EXCEPTION, or SV_AUDIT when writing new applications.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) required by the message text; the first string may be supplied in the origntr_id parameter instead of in this data string. Returned Parameters After the verb executes, SNAplus2 returns parameters to indicate whether the execution was successful and, if not, to indicate the reason the execution was unsuccessful.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) There is no SV_PARAMETER_CHECK secondary return code indicating that the specified message file was not found or could not be opened; this error will cause a return code of SV_UNEXPECTED_DOS_ERROR. Other Conditions Other conditions can result in the following primary return codes (primary_rc): SV_COMM_SUBSYSTEM_NOT_LOADED The SNAplus2 software has not been started. Contact the System Administrator for corrective action.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) Specify a string that identifies the user of this message file; for example, the name of the application if only one application uses this message file, or a string identifying a group of applications that use the same message file. The rest of the message source file consists of entries for individual messages. Each message is defined as a series of fields, as shown in the example that follows.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) User User error (for example, parameters that are not valid supplied on the command line to an application program). SNA SNA protocol violation by a remote system. Config Configuration mismatch. Audit A normal event, reported for information only. Cause The cause of the condition being logged. Action Any action that the local System Administrator should take as a result of the message.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) • Each field name (such as Message) must be at the start of a line, followed by a colon. Spaces or tabs following the colon are ignored. All the text associated with the field name must be in a single line (except when lines are concatenated using the $ character, as described below); there is no limit on the length of the line.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) • The fields Message, Type, Cause Type, Flags, and String must be specified.
Common Service Verbs Reference LOG_MESSAGE (HP-UX Systems Only) Creating the Message File from the Text File To convert the text file into a message file, use the snapmsgf program as follows: snapmsgf infile outfile The name of the input text file is infile, including a path if it is not in the current directory. The name of the output message file is outfile, as specified by the msg_file_name parameter on LOG_MESSAGE. The output file must have a name consisting of 1–3 characters with the extension .
Common Service Verbs Reference TRANSFER_MS_DATA TRANSFER_MS_DATA HP-UX Systems Only: The TRANSFER_MS_DATA verb, which was part of the Common Service Verbs API in previous versions of SNAplus2, is now included in the MS API. Refer to the HP-UX SNAplus2 MS Programmers Guide for more information about this verb.
Common Service Verbs Reference TRANSFER_MS_DATA unsigned short unsigned char far } TRANSFER_MS_DATA; dlen; *dptr; /* Length of data /* Data */ */ Supplied Parameters The program using this verb supplies the following parameters: opcode SV_TRANSFER_MS_DATA data_type Possible values are: SV_NMVT The data contains a complete NMVT. SV_ALERT_SUBVECTORS The data contains MS subvectors in the SNA-defined format for an Alert major vector. SNAplus2 adds an NMVT header and an alert major vector header.
Common Service Verbs Reference TRANSFER_MS_DATA • To request SNAplus2 to add the subvector, set this bit to 0. • To request SNAplus2 not to add the subvector, set this bit to 1. Bit 1—Add Product Set ID (0x10) subvector to the data. If the application supplies data that already contains a Product Set ID subvector, SNAplus2 adds its own Product Set ID subvector immediately preceding the existing one. • To request SNAplus2 to add the subvector, set this bit to 0.
Common Service Verbs Reference TRANSFER_MS_DATA This is an ASCII string of up to eight characters, using any locally displayable characters. The parameter is optional; set the first character to 0x00 if you do not want to include it. dlen Length of the data supplied by the application. The maximum length of an NMVT is 512 bytes. If the application is supplying a complete NMVT, the data length must not exceed 512 bytes.
Common Service Verbs Reference TRANSFER_MS_DATA SV_INVALID_DATA_TYPE The supplied data_type parameter was not one of the valid values. SV_INVALID_DATA_SEGMENT The supplied data string extended beyond the boundary of a data segment. SV_DATA_EXCEEDS_RU_SIZE One of the following occurred: • The application supplied a data string longer than the maximum NMVT size of 512 bytes.
Common Service Verbs Reference TRANSFER_MS_DATA outstanding. This verb has been cancelled; the data may not have been sent. primary_rc SV_COMM_SUBSYSTEM_NOT_LOADED The SNAplus2 software has not been started, or has been stopped. primary_rc SV_INVALID_VERB The opcode parameter did not match the operation code of any verb. No verb executed. primary_rc SV_INVALID_VERB_SEGMENT The supplied VCB extended beyond the boundary of a data segment.
Common Service Verbs Reference TRANSFER_MS_DATA system return code is returned through the secondary_rc. If the problem persists, consult the System Administrator for corrective action. For the meaning of the operating system return code, refer to your operating system documentation. This return code may also indicate that the application issuing the verb was invoked using the Windows function SendMessage instead of PostMessage; the application cannot issue any verbs in this state.
Index A ACSSVC, ACSSVC_C, ACSSVC_P entry points, 21 ACSSVC_C call, 23 acssvcc.
Index LOG_MESSAGE inserting text into message, 66 log category, 65 message file name, 65 returned parameters successful execution, 67 unsuccessful execution, 67 supplied parameters, 64 VCB, 64 verb, 64 M manual set, 14 message file, LOG_MESSAGE verb, 65 multithreaded programs, 33 P prerequisite knowledge, 10 S sample code, 31 sample type-G conversion table, 47 sending data to the host NetView program, 74 snapmsgf utility, 68 symbolic constants for hexadecimal values, 40 T trace files, 53 tracing APPC, 54
