ORGetValue 函式
擷取離線登錄區中指定之登錄值的型別和資料。
語法
DWORD ORGetValue(
_In_ ORHKEY Handle,
_In_opt_ PCWSTR lpSubKey,
_In_opt_ PCWSTR lpValue,
_Out_opt_ PDWORD pdwType,
_Out_opt_ PVOID pvData,
_Inout_opt_ PDWORD pcbData
);
參數
-
處理 [in]
-
離線登錄區中開啟登錄機碼的控制碼。
-
lpSubKey [in, optional]
-
登錄機碼的名稱。 此機碼必須是 Handle 參數所指定之索引鍵的子機碼。 此參數可以是 Null。
索引鍵名稱不區分大小寫。
-
lpValue [in, 選擇性]
-
登錄值的名稱。 如果此參數為 Null 或空字串 「」,則函式會擷取索引鍵未命名或預設值的類型和資料,如果有的話。 如需詳細資訊,請參閱 登錄專案大小限制。
索引鍵不會自動有未命名或預設值。 未命名的值可以是任何類型。
值名稱不區分大小寫。
-
pdwType [out, optional]
-
變數的指標,接收程式碼,指出儲存在指定值中的資料類型。 如需可能的類型代碼清單,請參閱 登錄實值型別。 如果不需要類型,這個參數可以是 Null 。
-
pvData [out, optional]
-
接收值資料之緩衝區的指標。 如果不需要資料,這個參數可以是 Null 。
如果資料是字串,函式會檢查是否有終止的 Null 字元。 如果找不到字串,如果緩衝區夠大,以容納額外的字元,則會以 Null 結束字元儲存字串。 否則,函式會失敗並傳回ERROR_MORE_DATA。
-
sqlData [in, out, optional]
-
變數的指標,指定 pvData 參數所指向的緩衝區大小,以位元組為單位。 當函式傳回時,此變數會包含複製到 pvData的資料大小。
只有當pvData為 Null 時,才能將它設定為Null。
如果資料具有REG_SZ、REG_MULTI_SZ或REG_EXPAND_SZ類型,則此大小包含任何終止的 Null 字元或字元。 如需詳細資訊,請參閱<備註>。
如果 pvData 參數指定的緩衝區不夠大,無法保存資料,函式會傳回ERROR_MORE_DATA,並將所需的緩衝區大小儲存在 由指向的變數中。 在此情況下, pvData 緩衝區的內容是未定義的。
如果 pvData 為 Null,且 其為 非Null,則函式會傳回ERROR_SUCCESS,並將資料的大小以位元組為單位儲存在 由 azureData指向的變數中。 這可讓應用程式判斷為值資料配置緩衝區的最佳方式。
傳回值
如果函式成功,傳回值會ERROR_SUCCESS。
如果函式失敗,傳回值是 Winerror.h 中定義的非零錯誤碼。 您可以使用 FormatMessage 函式搭配 FORMAT_MESSAGE_FROM_SYSTEM 旗標,以取得錯誤的一般描述。
備註
應用程式通常會呼叫 OREnumValue 函式來判斷值名稱,然後呼叫 ORGetValue 函式來擷取名稱的資料。
規格需求
需求 | 值 |
---|---|
可轉散發套件 |
Windows 離線登錄程式庫 1.0 版或更新版本 |
標頭 |
|
DLL |
|
另請參閱